Class: Google::Apis::FirestoreV1::FirestoreService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::FirestoreV1::FirestoreService

show all

Defined in:: lib/google/apis/firestore_v1/service.rb

Overview

Cloud Firestore API

Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.

Examples:

require 'google/apis/firestore_v1'

Firestore = Google::Apis::FirestoreV1 # Alias the module
service = Firestore::FirestoreService.new

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =

"https://firestore.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BatchWriteResponse
Applies a batch of write operations.
#batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BatchGetDocumentsResponse
Gets multiple documents.
#begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BeginTransactionResponse
Starts a new transaction.
#bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Bulk deletes a subset of documents from Google Cloud Firestore.
#cancel_project_database_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Starts asynchronous cancellation on a long-running operation.
#clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Creates a new database by cloning an existing one.
#commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::CommitResponse
Commits a transaction, while optionally updating documents.
#create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Create a database.
#create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
Creates a backup schedule on a database.
#create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
Creates a new change stream for the database.
#create_project_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Creates a composite index.
#create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Document
Creates a new document.
#create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
Create a user creds.
#delete_project_database(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Deletes a database.
#delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a backup schedule.
#delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a change stream.
#delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a composite index.
#delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a document.
#delete_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a long-running operation.
#delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a user creds.
#delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Deletes a backup.
#disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
Disables a user creds.
#enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
Enables a user creds.
#execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ExecutePipelineResponse
Executes a pipeline query.
#export_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
#get_project_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database
Gets information about a database.
#get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
Gets information about a backup schedule.
#get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
Gets information about a change stream.
#get_project_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field
Gets the metadata and configuration for a Field.
#get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index
Gets a composite index.
#get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Document
Gets a single document.
#get_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
Gets a user creds resource.
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Location
Gets information about a location.
#get_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup
Gets information about a backup.
#import_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Imports documents into Google Cloud Firestore.
#initialize ⇒ FirestoreService constructor
A new instance of FirestoreService.
#list_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListCollectionIdsResponse
Lists all the collection IDs underneath a document.
#list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse
List backup schedules.
#list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse
Lists all change streams in a database.
#list_project_database_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse
Lists the field configuration and metadata for this database.
#list_project_database_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse
Lists composite indexes.
#list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListDocumentsResponse
Lists documents.
#list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListDocumentsResponse
Lists documents.
#list_project_database_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
#list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse
List all user creds in the database.
#list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse
List all the databases in the project.
#list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse
Lists all the backups.
#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListLocationsResponse
Lists information about the supported locations for this service.
#listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListenResponse
Listens to changes.
#partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::PartitionQueryResponse
Partitions a query by returning partition cursors that can be used to run the query in parallel.
#patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Updates a database.
#patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
Updates a backup schedule.
#patch_project_database_collection_group_field(name, google_firestore_admin_v1_field_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Updates a field configuration.
#patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, request_options_request_tags: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Document
Updates or inserts a document.
#reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
Resets the password of a user creds.
#restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation
Creates a new database by restoring from an existing backup.
#rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty
Rolls back a transaction.
#run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::RunAggregationQueryResponse
Runs an aggregation query.
#run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::RunQueryResponse
Runs a query.
#write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::WriteResponse
Streams batches of document updates and deletes, in order.

Constructor Details

#initialize ⇒ `FirestoreService`

Returns a new instance of FirestoreService.

# File 'lib/google/apis/firestore_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-firestore_v1',
        client_version: Google::Apis::FirestoreV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ `String`

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

(String) —
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43

# File 'lib/google/apis/firestore_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ `String`

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

(String) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48

# File 'lib/google/apis/firestore_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BatchWriteResponse`

Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
batch_write_request_object (Google::Apis::FirestoreV1::BatchWriteRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::BatchWriteResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::BatchWriteResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1075

def batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:batchWrite', options)
  command.request_representation = Google::Apis::FirestoreV1::BatchWriteRequest::Representation
  command.request_object = batch_write_request_object
  command.response_representation = Google::Apis::FirestoreV1::BatchWriteResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::BatchWriteResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BatchGetDocumentsResponse`

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
batch_get_documents_request_object (Google::Apis::FirestoreV1::BatchGetDocumentsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::BatchGetDocumentsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::BatchGetDocumentsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1037

def batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:batchGet', options)
  command.request_representation = Google::Apis::FirestoreV1::BatchGetDocumentsRequest::Representation
  command.request_object = batch_get_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1::BatchGetDocumentsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::BatchGetDocumentsResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BeginTransactionResponse`

Starts a new transaction.

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
begin_transaction_request_object (Google::Apis::FirestoreV1::BeginTransactionRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::BeginTransactionResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::BeginTransactionResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1109

def begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:beginTransaction', options)
  command.request_representation = Google::Apis::FirestoreV1::BeginTransactionRequest::Representation
  command.request_object = begin_transaction_request_object
  command.response_representation = Google::Apis::FirestoreV1::BeginTransactionResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::BeginTransactionResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

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. For more details on bulk delete behavior, refer to: https://cloud.google.com/ firestore/docs/manage-data/bulk-delete

Parameters:

name (String) —
Required. Database to operate. Should be of the form: projects/project_id/ databases/database_id``.
google_firestore_admin_v1_bulk_delete_documents_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 82

def bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:bulkDeleteDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1_bulk_delete_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_database_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

name (String) —
The name of the operation resource to be cancelled.
google_longrunning_cancel_operation_request_object (Google::Apis::FirestoreV1::GoogleLongrunningCancelOperationRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1834

def cancel_project_database_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

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 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. The long-running operation can be used to track the progress of the clone, with the Operation's metadata field type being the CloneDatabaseMetadata. The response type is the Database if the clone was successful. The new database is not readable or writeable until the LRO has completed.

Parameters:

parent (String) —
Required. The project to clone the database in. Format is projects/ project_id``.
google_firestore_admin_v1_clone_database_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CloneDatabaseRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 124

def clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/databases:clone', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CloneDatabaseRequest::Representation
  command.request_object = google_firestore_admin_v1_clone_database_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::CommitResponse`

Commits a transaction, while optionally updating documents.

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
commit_request_object (Google::Apis::FirestoreV1::CommitRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::CommitResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::CommitResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1143

def commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:commit', options)
  command.request_representation = Google::Apis::FirestoreV1::CommitRequest::Representation
  command.request_object = commit_request_object
  command.response_representation = Google::Apis::FirestoreV1::CommitResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::CommitResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Create a database.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id``
google_firestore_admin_v1_database_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database) (defaults to: nil)
database_id (String) (defaults to: nil) —
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-/ 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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 164

def create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/databases', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
  command.request_object = google_firestore_admin_v1_database_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['databaseId'] = database_id unless database_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

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.

Parameters:

parent (String) —
Required. The parent database. Format projects/project/databases/database``
google_firestore_admin_v1_backup_schedule_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 457

def create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/backupSchedules', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
  command.request_object = google_firestore_admin_v1_backup_schedule_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream`

Creates a new change stream for the database.

Parameters:

parent (String) —
Required. The parent database to create the change stream for. Format is projects/project/databases/database``.
google_firestore_admin_v1_change_stream_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream) (defaults to: nil)
change_stream_id (String) (defaults to: nil) —
Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 628

def create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/changeStreams', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
  command.request_object = google_firestore_admin_v1_change_stream_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
  command.params['parent'] = parent unless parent.nil?
  command.query['changeStreamId'] = change_stream_id unless change_stream_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id/databases/ database_id/collectionGroups/collection_id``
google_firestore_admin_v1_index_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 899

def create_project_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/indexes', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation
  command.request_object = google_firestore_admin_v1_index_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Document`

Creates a new document.

Parameters:

parent (String) —
Required. The parent resource. For example: projects/project_id/databases/ database_id/documents or projects/project_id/databases/database_id/ documents/chatrooms/chatroom_id``
collection_id (String) —
Required. The collection ID, relative to parent, to list. For example: chatrooms.
document_object (Google::Apis::FirestoreV1::Document) (defaults to: nil)
document_id (String) (defaults to: nil) —
The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Document) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Document)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1189

def create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/{collectionId}', options)
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
  command.request_object = document_object
  command.response_representation = Google::Apis::FirestoreV1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1::Document
  command.params['parent'] = parent unless parent.nil?
  command.params['collectionId'] = collection_id unless collection_id.nil?
  command.query['documentId'] = document_id unless document_id.nil?
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

Create a user creds.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id/databases/ database_id``
google_firestore_admin_v1_user_creds_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) (defaults to: nil)
user_creds_id (String) (defaults to: nil) —
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-/ 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/.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1987

def create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/userCreds', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.request_object = google_firestore_admin_v1_user_creds_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
  command.params['parent'] = parent unless parent.nil?
  command.query['userCredsId'] = user_creds_id unless user_creds_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Deletes a database.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id``
etag (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 201

def delete_project_database(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a backup schedule.

Parameters:

name (String) —
Required. The name of the backup schedule. Format projects/project/ databases/database/backupSchedules/backup_schedule``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 490

def delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a change stream.

Parameters:

name (String) —
Required. The name of the change stream to delete. Format is projects/ project/databases/database/changeStreams/change_stream``.
etag (String) (defaults to: nil) —
Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 665

def delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a composite index.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ collectionGroups/collection_id/indexes/index_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 932

def delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a document.

Parameters:

name (String) —
Required. The resource name of the Document to delete. In the format: projects/project_id/databases/database_id/documents/document_path``.
current_document_exists (Boolean) (defaults to: nil) —
When set to true, the target document must exist. When set to false, the target document must not exist.
current_document_update_time (String) (defaults to: nil) —
When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1234

def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

name (String) —
The name of the operation resource to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1869

def delete_project_database_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a user creds.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ userCreds/user_creds_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2021

def delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Deletes a backup.

Parameters:

name (String) —
Required. Name of the backup to delete. format is projects/project/ locations/location/backups/backup``.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2304

def delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

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

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ userCreds/user_creds_id``
google_firestore_admin_v1_disable_user_creds_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DisableUserCredsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2053

def disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:disable', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DisableUserCredsRequest::Representation
  command.request_object = google_firestore_admin_v1_disable_user_creds_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

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

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ userCreds/user_creds_id``
google_firestore_admin_v1_enable_user_creds_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EnableUserCredsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2087

def enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:enable', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EnableUserCredsRequest::Representation
  command.request_object = google_firestore_admin_v1_enable_user_creds_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ExecutePipelineResponse`

Executes a pipeline query.

Parameters:

database (String) —
Required. Database identifier, in the form projects/project/databases/ database``.
execute_pipeline_request_object (Google::Apis::FirestoreV1::ExecutePipelineRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ExecutePipelineResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ExecutePipelineResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1269

def execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:executePipeline', options)
  command.request_representation = Google::Apis::FirestoreV1::ExecutePipelineRequest::Representation
  command.request_object = execute_pipeline_request_object
  command.response_representation = Google::Apis::FirestoreV1::ExecutePipelineResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ExecutePipelineResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

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. For more details on export behavior and output format, refer to: https://cloud.google. com/firestore/docs/manage-data/export-import

Parameters:

name (String) —
Required. Database to export. Should be of the form: projects/project_id/ databases/database_id``.
google_firestore_admin_v1_export_documents_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 242

def export_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:exportDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1_export_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database`

Gets information about a database.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 274

def get_project_database(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

Gets information about a backup schedule.

Parameters:

name (String) —
Required. The name of the backup schedule. Format projects/project/ databases/database/backupSchedules/backup_schedule``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 521

def get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream`

Gets information about a change stream.

Parameters:

name (String) —
Required. The name of the change stream to retrieve. Format is projects/ project/databases/database/changeStreams/change_stream``.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 697

def get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field`

Gets the metadata and configuration for a Field.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ collectionGroups/collection_id/fields/field_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 759

def get_project_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index`

Gets a composite index.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ collectionGroups/collection_id/indexes/index_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 963

def get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Document`

Gets a single document.

Parameters:

name (String) —
Required. The resource name of the Document to get. In the format: projects/ project_id/databases/database_id/documents/document_path``.
mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
read_time (String) (defaults to: nil) —
Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
transaction (String) (defaults to: nil) —
Reads the document in a transaction.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Document) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Document)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1314

def get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1::Document
  command.params['name'] = name unless name.nil?
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
  command.query['readTime'] = read_time unless read_time.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['transaction'] = transaction unless transaction.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

name (String) —
The name of the operation resource.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1900

def get_project_database_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

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

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ userCreds/user_creds_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2121

def get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Location`

Gets information about a location.

Parameters:

name (String) —
Resource name for the location.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Location) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Location)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2217

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::Location::Representation
  command.response_class = Google::Apis::FirestoreV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup`

Gets information about a backup.

Parameters:

name (String) —
Required. Name of the backup to fetch. Format is projects/project/locations/location/backups/backup``.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2335

def get_project_location_backup(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

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.

Parameters:

name (String) —
Required. Database to import into. Should be of the form: projects/ project_id/databases/database_id``.
google_firestore_admin_v1_import_documents_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 310

def import_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:importDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1_import_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListCollectionIdsResponse`

Lists all the collection IDs underneath a document.

Parameters:

parent (String) —
Required. The parent document. In the format: projects/project_id/databases/database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documents/chatrooms/my-chatroomUseprojects/project_id/databases/database_id/documents` to list top-level collections.
list_collection_ids_request_object (Google::Apis::FirestoreV1::ListCollectionIdsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ListCollectionIdsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ListCollectionIdsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1437

def list_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:listCollectionIds', options)
  command.request_representation = Google::Apis::FirestoreV1::ListCollectionIdsRequest::Representation
  command.request_object = list_collection_ids_request_object
  command.response_representation = Google::Apis::FirestoreV1::ListCollectionIdsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ListCollectionIdsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse`

List backup schedules.

Parameters:

parent (String) —
Required. The parent database. Format is projects/project/databases/ database``.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 552

def list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backupSchedules', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse`

Lists all change streams in a database.

Parameters:

parent (String) —
Required. The parent database to list change streams from. Format is projects/project/databases/database``.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 728

def list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/changeStreams', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse`

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false or ttlConfig:*.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id/databases/ database_id/collectionGroups/collection_id``
filter (String) (defaults to: nil) —
The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig. usesAncestorConfig:false or ttlConfig:*.
page_size (Fixnum) (defaults to: nil) —
The number of results to return.
page_token (String) (defaults to: nil) —
A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 803

def list_project_database_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/fields', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse`

Lists composite indexes.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id/databases/ database_id/collectionGroups/collection_id``
filter (String) (defaults to: nil) —
The filter to apply to list results.
page_size (Fixnum) (defaults to: nil) —
The number of results to return.
page_token (String) (defaults to: nil) —
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1001

def list_project_database_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/indexes', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListDocumentsResponse`

Lists documents.

Parameters:

parent (String) —
Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`
collection_id (String) —
Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.
mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
order_by (String) (defaults to: nil) —
Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListDocuments response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.
read_time (String) (defaults to: nil) —
Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
recursive (Boolean) (defaults to: nil) —
Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a collection_id, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with recursive may not specify show_missing.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
show_missing (Boolean) (defaults to: nil) —
If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set. Requests with show_missing may not specify where or order_by.
transaction (String) (defaults to: nil) —
Perform the read as part of an already active transaction.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ListDocumentsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ListDocumentsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1514

def list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['collectionId'] = collection_id unless collection_id.nil?
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readTime'] = read_time unless read_time.nil?
  command.query['recursive'] = recursive unless recursive.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['showMissing'] = show_missing unless show_missing.nil?
  command.query['transaction'] = transaction unless transaction.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListDocumentsResponse`

Lists documents.

Parameters:

parent (String) —
Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`
collection_id (String) —
Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.
mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
order_by (String) (defaults to: nil) —
Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListDocuments response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.
read_time (String) (defaults to: nil) —
Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
recursive (Boolean) (defaults to: nil) —
Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a collection_id, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with recursive may not specify show_missing.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
show_missing (Boolean) (defaults to: nil) —
If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set. Requests with show_missing may not specify where or order_by.
transaction (String) (defaults to: nil) —
Perform the read as part of an already active transaction.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ListDocumentsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ListDocumentsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1393

def list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['collectionId'] = collection_id unless collection_id.nil?
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readTime'] = read_time unless read_time.nil?
  command.query['recursive'] = recursive unless recursive.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['showMissing'] = show_missing unless show_missing.nil?
  command.query['transaction'] = transaction unless transaction.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse`

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

name (String) —
The name of the operation's parent resource.
filter (String) (defaults to: nil) —
The standard list filter.
page_size (Fixnum) (defaults to: nil) —
The standard list page size.
page_token (String) (defaults to: nil) —
The standard list page token.
return_partial_success (Boolean) (defaults to: nil) —
When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1945

def list_project_database_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse`

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

Parameters:

parent (String) —
Required. A parent database name of the form projects/project_id/databases/ database_id``
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2153

def list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/userCreds', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse`

List all the databases in the project.

Parameters:

parent (String) —
Required. A parent name of the form projects/project_id``
show_deleted (Boolean) (defaults to: nil) —
If true, also returns deleted resources.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 344

def list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/databases', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse`

Lists all the backups.

Parameters:

parent (String) —
Required. The location to list backups from. Format is projects/project/ locations/location. Uselocation= '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.
filter (String) (defaults to: nil) —
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 are eligible for filtering: * database_uid (supports = only)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2375

def list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/backups', options)
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListLocationsResponse`

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

name (String) —
The resource that owns the locations collection, if applicable.
extra_location_types (Array<String>, String) (defaults to: nil) —
Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter (String) (defaults to: nil) —
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
page_size (Fixnum) (defaults to: nil) —
The maximum number of results to return. If not set, the service selects a default.
page_token (String) (defaults to: nil) —
A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ListLocationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ListLocationsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2269

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::FirestoreV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListenResponse`

Listens to changes. This method is only available via gRPC or WebChannel (not REST).

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
listen_request_object (Google::Apis::FirestoreV1::ListenRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::ListenResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::ListenResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1557

def listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:listen', options)
  command.request_representation = Google::Apis::FirestoreV1::ListenRequest::Representation
  command.request_object = listen_request_object
  command.response_representation = Google::Apis::FirestoreV1::ListenResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::ListenResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::PartitionQueryResponse`

Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.

Parameters:

parent (String) —
Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents. Document resource names are not supported; only database resource names can be specified.
partition_query_request_object (Google::Apis::FirestoreV1::PartitionQueryRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::PartitionQueryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::PartitionQueryResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1594

def partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:partitionQuery', options)
  command.request_representation = Google::Apis::FirestoreV1::PartitionQueryRequest::Representation
  command.request_object = partition_query_request_object
  command.response_representation = Google::Apis::FirestoreV1::PartitionQueryResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::PartitionQueryResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Updates a database.

Parameters:

name (String) —
The resource name of the Database. Format: projects/project/databases/ database``
google_firestore_admin_v1_database_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database) (defaults to: nil)
update_mask (String) (defaults to: nil) —
The list of fields to be updated.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 379

def patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
  command.request_object = google_firestore_admin_v1_database_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

Updates a backup schedule.

Parameters:

name (String) —
Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/project/databases/database/backupSchedules/backup_schedule``
google_firestore_admin_v1_backup_schedule_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule) (defaults to: nil)
update_mask (String) (defaults to: nil) —
The list of fields to be updated.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 587

def patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
  command.request_object = google_firestore_admin_v1_backup_schedule_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_database_collection_group_field(name, google_firestore_admin_v1_field_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField 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 which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. 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/*.

Parameters:

name (String) —
Required. A field name of the form: projects/project_id/databases/ database_id/collectionGroups/collection_id/fields/field_pathA field path can be a simple field name, e.g. `address` or a path to fields within ` map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:,., (backtick), [, ], as well as any ascii symbolic characters. Examples: `address.city` represents a field named address.city, not the map key city in the field address. `represents a field named, not any field. A specialFieldcontains the default indexing settings for all fields. This field's resource name is:projects/project_id/databases/database_id/ collectionGroups/default/fields/Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.
google_firestore_admin_v1_field_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field) (defaults to: nil)
update_mask (String) (defaults to: nil) —
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 862

def patch_project_database_collection_group_field(name, google_firestore_admin_v1_field_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field::Representation
  command.request_object = google_firestore_admin_v1_field_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, request_options_request_tags: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Document`

Updates or inserts a document.

Parameters:

name (String) —
The resource name of the document, for example projects/project_id/ databases/database_id/documents/document_path``.
document_object (Google::Apis::FirestoreV1::Document) (defaults to: nil)
current_document_exists (Boolean) (defaults to: nil) —
When set to true, the target document must exist. When set to false, the target document must not exist.
current_document_update_time (String) (defaults to: nil) —
When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
request_options_request_tags (Array<String>, String) (defaults to: nil) —
Optional. The request tags for the request.
update_mask_field_paths (Array<String>, String) (defaults to: nil) —
The list of field paths in the mask. See Document.fields for a field path syntax reference.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Document) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Document)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1642

def patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, request_options_request_tags: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
  command.request_object = document_object
  command.response_representation = Google::Apis::FirestoreV1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1::Document
  command.params['name'] = name unless name.nil?
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
  command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
  command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

Resets the password of a user creds.

Parameters:

name (String) —
Required. A name of the form projects/project_id/databases/database_id/ userCreds/user_creds_id``
google_firestore_admin_v1_reset_user_password_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResetUserPasswordRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 2185

def reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resetPassword', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ResetUserPasswordRequest::Representation
  command.request_object = google_firestore_admin_v1_reset_user_password_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

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 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. The long- running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.

Parameters:

parent (String) —
Required. The project to restore the database in. Format is projects/ project_id``.
google_firestore_admin_v1_restore_database_request_object (Google::Apis::FirestoreV1::GoogleFirestoreAdminV1RestoreDatabaseRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 422

def restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/databases:restore', options)
  command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1RestoreDatabaseRequest::Representation
  command.request_object = google_firestore_admin_v1_restore_database_request_object
  command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

Rolls back a transaction.

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``.
rollback_request_object (Google::Apis::FirestoreV1::RollbackRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1681

def rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:rollback', options)
  command.request_representation = Google::Apis::FirestoreV1::RollbackRequest::Representation
  command.request_object = rollback_request_object
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1::Empty
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::RunAggregationQueryResponse`

Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );

Parameters:

parent (String) —
Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`
run_aggregation_query_request_object (Google::Apis::FirestoreV1::RunAggregationQueryRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::RunAggregationQueryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::RunAggregationQueryResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1722

def run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:runAggregationQuery', options)
  command.request_representation = Google::Apis::FirestoreV1::RunAggregationQueryRequest::Representation
  command.request_object = run_aggregation_query_request_object
  command.response_representation = Google::Apis::FirestoreV1::RunAggregationQueryResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::RunAggregationQueryResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::RunQueryResponse`

Runs a query.

Parameters:

parent (String) —
Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`
run_query_request_object (Google::Apis::FirestoreV1::RunQueryRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::RunQueryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::RunQueryResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1759

def run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:runQuery', options)
  command.request_representation = Google::Apis::FirestoreV1::RunQueryRequest::Representation
  command.request_object = run_query_request_object
  command.response_representation = Google::Apis::FirestoreV1::RunQueryResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::RunQueryResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::WriteResponse`

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

Parameters:

database (String) —
Required. The database name. In the format: projects/project_id/databases/ database_id``. This is only required in the first message.
write_request_object (Google::Apis::FirestoreV1::WriteRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::FirestoreV1::WriteResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::FirestoreV1::WriteResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/firestore_v1/service.rb', line 1794

def write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+database}/documents:write', options)
  command.request_representation = Google::Apis::FirestoreV1::WriteRequest::Representation
  command.request_object = write_request_object
  command.response_representation = Google::Apis::FirestoreV1::WriteResponse::Representation
  command.response_class = Google::Apis::FirestoreV1::WriteResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::FirestoreV1::FirestoreService

Overview

Examples:

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FirestoreService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

Instance Method Details

#batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BatchWriteResponse

#batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BatchGetDocumentsResponse

#begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::BeginTransactionResponse

#bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#cancel_project_database_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::CommitResponse

#create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule

#create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream

#create_project_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Document

#create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds

#delete_project_database(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds

#enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds

#execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ExecutePipelineResponse

#export_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#get_project_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database

#get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule

#get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream

#get_project_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field

#get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index

#get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Document

#get_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Location

#get_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup

#import_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#list_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListCollectionIdsResponse

#list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse

#list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse

#list_project_database_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse

#list_project_database_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse

#list_project_database_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse

#list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse

#list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse

#list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListLocationsResponse

#listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::ListenResponse

#partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::PartitionQueryResponse

#patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule

#patch_project_database_collection_group_field(name, google_firestore_admin_v1_field_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds

#restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::GoogleLongrunningOperation

#rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::Empty

#run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::RunAggregationQueryResponse

#run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::RunQueryResponse

#write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1::WriteResponse

#initialize ⇒ `FirestoreService`

#key ⇒ `String`

#quota_user ⇒ `String`

#batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BatchWriteResponse`

#batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BatchGetDocumentsResponse`

#begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::BeginTransactionResponse`

#bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#cancel_project_database_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#clone_project_database(parent, google_firestore_admin_v1_clone_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::CommitResponse`

#create_project_database(parent, google_firestore_admin_v1_database_object = nil, database_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#create_project_database_backup_schedule(parent, google_firestore_admin_v1_backup_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

#create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream`

#create_project_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Document`

#create_project_database_user_cred(parent, google_firestore_admin_v1_user_creds_object = nil, user_creds_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

#delete_project_database(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#delete_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#delete_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#disable_project_database_user_cred(name, google_firestore_admin_v1_disable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

#enable_project_database_user_cred(name, google_firestore_admin_v1_enable_user_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

#execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ExecutePipelineResponse`

#export_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#get_project_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database`

#get_project_database_backup_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

#get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream`

#get_project_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field`

#get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index`

#get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Document`

#get_project_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#get_project_database_user_cred(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Location`

#get_project_location_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup`

#import_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#list_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListCollectionIdsResponse`

#list_project_database_backup_schedules(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupSchedulesResponse`

#list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse`

#list_project_database_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse`

#list_project_database_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse`

#list_project_database_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningListOperationsResponse`

#list_project_database_user_creds(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListUserCredsResponse`

#list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse`

#list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse`

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListLocationsResponse`

#listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::ListenResponse`

#partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::PartitionQueryResponse`

#patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#patch_project_database_backup_schedule(name, google_firestore_admin_v1_backup_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSchedule`

#patch_project_database_collection_group_field(name, google_firestore_admin_v1_field_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#reset_project_database_user_cred_password(name, google_firestore_admin_v1_reset_user_password_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleFirestoreAdminV1UserCreds`

#restore_project_database(parent, google_firestore_admin_v1_restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::GoogleLongrunningOperation`

#rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::Empty`

#run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::RunAggregationQueryResponse`

#run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::RunQueryResponse`

#write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::FirestoreV1::WriteResponse`