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

Inherits:
Core::BaseService
  • Object
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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FirestoreService

Returns a new instance of FirestoreService.



46
47
48
49
50
51
 
# File 'lib/google/apis/firestore_v1/service.rb', line 46

def initialize
  super('https://firestore.googleapis.com/', '',
        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.



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

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.



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

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:

Returns:

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



569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/google/apis/firestore_v1/service.rb', line 569

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:

Returns:

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



531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/google/apis/firestore_v1/service.rb', line 531

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:

Returns:

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



603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/apis/firestore_v1/service.rb', line 603

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

#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:

Returns:

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



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1196

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

#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:

Returns:

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



637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/apis/firestore_v1/service.rb', line 637

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_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:

Returns:

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



393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/apis/firestore_v1/service.rb', line 393

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

  • 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:

Returns:

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



681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/google/apis/firestore_v1/service.rb', line 681

def create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: 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['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:

Returns:

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



426
427
428
429
430
431
432
433
434
 
# File 'lib/google/apis/firestore_v1/service.rb', line 426

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

  • 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:

Returns:

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



723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/google/apis/firestore_v1/service.rb', line 723

def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: 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['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:

Returns:

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



1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1231

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

#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:

Returns:

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



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/google/apis/firestore_v1/service.rb', line 83

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:

Returns:

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



115
116
117
118
119
120
121
122
123
 
# File 'lib/google/apis/firestore_v1/service.rb', line 115

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_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:

Returns:

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



251
252
253
254
255
256
257
258
259
 
# File 'lib/google/apis/firestore_v1/service.rb', line 251

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:

Returns:

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



457
458
459
460
461
462
463
464
465
 
# File 'lib/google/apis/firestore_v1/service.rb', line 457

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, 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 may not be older than 270 seconds.

  • 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:

Returns:

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



764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/google/apis/firestore_v1/service.rb', line 764

def get_project_database_document(name, mask_field_paths: nil, read_time: 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['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:

Returns:

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



1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1262

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_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:

Returns:

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



1338
1339
1340
1341
1342
1343
1344
1345
1346
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1338

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

#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:

Returns:

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



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/google/apis/firestore_v1/service.rb', line 151

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

  • 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:

Returns:

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



865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/google/apis/firestore_v1/service.rb', line 865

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

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 .

  • 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:

Returns:

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



295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/google/apis/firestore_v1/service.rb', line 295

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:

Returns:

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



495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apis/firestore_v1/service.rb', line 495

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, 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) —

    Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

  • 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) —

    The order to sort results by. For example: priority desc, name.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of documents to return.

  • page_token (String) (defaults to: nil) —

    The next_page_token value returned from a previous List request, if any.

  • read_time (String) (defaults to: nil) —

    Reads documents as they were at the given time. This may not be older than 270 seconds.

  • show_missing (Boolean) (defaults to: nil) —

    If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document. update_time set. Requests with show_missing may not specify where or order_by.

  • transaction (String) (defaults to: nil) —

    Reads documents 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:

Returns:

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



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/google/apis/firestore_v1/service.rb', line 924

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, 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['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, 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) —

    Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

  • 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) —

    The order to sort results by. For example: priority desc, name.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of documents to return.

  • page_token (String) (defaults to: nil) —

    The next_page_token value returned from a previous List request, if any.

  • read_time (String) (defaults to: nil) —

    Reads documents as they were at the given time. This may not be older than 270 seconds.

  • show_missing (Boolean) (defaults to: nil) —

    If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document. update_time set. Requests with show_missing may not specify where or order_by.

  • transaction (String) (defaults to: nil) —

    Reads documents 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:

Returns:

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



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/google/apis/firestore_v1/service.rb', line 824

def list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: 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['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, 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. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.

  • 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:

Returns:

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



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1305

def list_project_database_operations(name, filter: nil, page_size: nil, page_token: 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['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, 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``

  • 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:

Returns:

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



183
184
185
186
187
188
189
190
191
 
# File 'lib/google/apis/firestore_v1/service.rb', line 183

def list_project_databases(parent, 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['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, 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.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • 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:

Returns:

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



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1378

def list_project_locations(name, 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['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.

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:

Returns:

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



964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/google/apis/firestore_v1/service.rb', line 964

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:

Returns:

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



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1001

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:

Returns:

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



217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/google/apis/firestore_v1/service.rb', line 217

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_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 may 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 may be quoted using ` (backtick). The only character that needs to 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: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.`` 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:

Returns:

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



356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/apis/firestore_v1/service.rb', line 356

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

  • 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:

Returns:

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



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1047

def patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: 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['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

#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:

Returns:

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



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1085

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_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:

Returns:

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



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1122

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.

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:

Returns:

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



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/google/apis/firestore_v1/service.rb', line 1156

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