Class: Google::Apis::FirestoreV1beta1::FirestoreService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/firestore_v1beta1/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_v1beta1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ FirestoreService

Returns a new instance of FirestoreService



46
47
48
49
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 46

def initialize
  super('https://firestore.googleapis.com/', '')
  @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 'generated/google/apis/firestore_v1beta1/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 'generated/google/apis/firestore_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::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) —

    The database name. In the format: projects/project_id/databases/database_id``.

  • batch_get_documents_request_object (Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



154
155
156
157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 154

def batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:batchGet', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest::Representation
  command.request_object = batch_get_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::BeginTransactionResponse

Starts a new transaction.

Parameters:

  • database (String) —

    The database name. In the format: projects/project_id/databases/database_id``.

  • begin_transaction_request_object (Google::Apis::FirestoreV1beta1::BeginTransactionRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



188
189
190
191
192
193
194
195
196
197
198
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 188

def begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:beginTransaction', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::BeginTransactionRequest::Representation
  command.request_object = begin_transaction_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::BeginTransactionResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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

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

Commits a transaction, while optionally updating documents.

Parameters:

  • database (String) —

    The database name. In the format: projects/project_id/databases/database_id``.

  • commit_request_object (Google::Apis::FirestoreV1beta1::CommitRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



222
223
224
225
226
227
228
229
230
231
232
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 222

def commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:commit', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::CommitRequest::Representation
  command.request_object = commit_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::CommitResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_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::FirestoreV1beta1::Document

Creates a new document.

Parameters:

  • parent (String) —

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

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

  • document_object (Google::Apis::FirestoreV1beta1::Document) (defaults to: nil)
  • document_id (String) —

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

    The list of field paths in the mask. See Document.fields for a field path syntax reference.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 266

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, 'v1beta1/{+parent}/{collectionId}', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
  command.request_object = document_object
  command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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

#create_project_database_index(parent, google_firestore_admin_v1beta1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.

Parameters:

  • parent (String) —

    The name of the database this index will apply to. For example: projects/project_id/databases/database_id``

  • google_firestore_admin_v1beta1_index_object (Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



688
689
690
691
692
693
694
695
696
697
698
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 688

def create_project_database_index(parent, google_firestore_admin_v1beta1_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/indexes', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index::Representation
  command.request_object = google_firestore_admin_v1beta1_index_object
  command.response_representation = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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

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

Deletes a document.

Parameters:

  • name (String) —

    The resource name of the Document to delete. In the format: projects/project_id/databases/database_id/documents/document_path``.

  • current_document_exists (Boolean) —

    When set to true, the target document must exist. When set to false, the target document must not exist.

  • current_document_update_time (String) —

    When set, the target document must exist and have been last updated at that time.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



308
309
310
311
312
313
314
315
316
317
318
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 308

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, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::Empty

Deletes an index.

Parameters:

  • name (String) —

    The index name. For example: projects/project_id/databases/database_id/indexes/index_id``

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



721
722
723
724
725
726
727
728
729
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 721

def delete_project_database_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_v1beta1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::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.

Parameters:

  • name (String) —

    Database to export. Should be of the form: projects/project_id/databases/database_id``.

  • google_firestore_admin_v1beta1_export_documents_request_object (Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 80

def export_project_database_documents(name, google_firestore_admin_v1beta1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:exportDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1beta1_export_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_document(name, mask_field_paths: nil, read_time: nil, transaction: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::Document

Gets a single document.

Parameters:

  • name (String) —

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

    The list of field paths in the mask. See Document.fields for a field path syntax reference.

  • read_time (String) —

    Reads the version of the document at the given time. This may not be older than 60 seconds.

  • transaction (String) —

    Reads the document in a transaction.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 349

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, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index

Gets an index.

Parameters:

  • name (String) —

    The name of the index. For example: projects/project_id/databases/database_id/indexes/index_id``

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



752
753
754
755
756
757
758
759
760
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 752

def get_project_database_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index
  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_v1beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::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) —

    Database to import into. Should be of the form: projects/project_id/databases/database_id``.

  • google_firestore_admin_v1beta1_import_documents_request_object (Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



118
119
120
121
122
123
124
125
126
127
128
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 118

def import_project_database_documents(name, google_firestore_admin_v1beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+name}:importDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1beta1_import_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_project_database_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse

Lists all the collection IDs underneath a document.

Parameters:

  • parent (String) —

    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::FirestoreV1beta1::ListCollectionIdsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



453
454
455
456
457
458
459
460
461
462
463
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 453

def list_project_database_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}:listCollectionIds', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::ListCollectionIdsRequest::Representation
  command.request_object = list_collection_ids_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_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::FirestoreV1beta1::ListDocumentsResponse

Lists documents.

Parameters:

  • parent (String) —

    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/documentsor projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

  • collection_id (String) —

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

  • mask_field_paths (Array<String>, String) —

    The list of field paths in the mask. See Document.fields for a field path syntax reference.

  • order_by (String) —

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

  • page_size (Fixnum) —

    The maximum number of documents to return.

  • page_token (String) —

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

  • read_time (String) —

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

  • show_missing (Boolean) —

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

    Reads documents in a transaction.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 411

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, 'v1beta1/{+parent}/{collectionId}', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ListIndexesResponse

Lists the indexes that match the specified filters.

Parameters:

  • parent (String) —

    The database name. For example: projects/project_id/databases/database_id``

  • filter (String)
  • page_size (Fixnum) —

    The standard List page size.

  • page_token (String) —

    The standard List page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 788

def list_project_database_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/indexes', options)
  command.response_representation = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ListIndexesResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ListIndexesResponse
  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

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

Listens to changes.

Parameters:

  • database (String) —

    The database name. In the format: projects/project_id/databases/database_id``.

  • listen_request_object (Google::Apis::FirestoreV1beta1::ListenRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



487
488
489
490
491
492
493
494
495
496
497
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 487

def listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:listen', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::ListenRequest::Representation
  command.request_object = listen_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::ListenResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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

#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::FirestoreV1beta1::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::FirestoreV1beta1::Document) (defaults to: nil)
  • current_document_exists (Boolean) —

    When set to true, the target document must exist. When set to false, the target document must not exist.

  • current_document_update_time (String) —

    When set, the target document must exist and have been last updated at that time.

  • mask_field_paths (Array<String>, String) —

    The list of field paths in the mask. See Document.fields for a field path syntax reference.

  • update_mask_field_paths (Array<String>, String) —

    The list of field paths in the mask. See Document.fields for a field path syntax reference.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 533

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
  command.request_object = document_object
  command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::Empty

Rolls back a transaction.

Parameters:

  • database (String) —

    The database name. In the format: projects/project_id/databases/database_id``.

  • rollback_request_object (Google::Apis::FirestoreV1beta1::RollbackRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



571
572
573
574
575
576
577
578
579
580
581
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 571

def rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:rollback', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::RollbackRequest::Representation
  command.request_object = rollback_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::RunQueryResponse

Runs a query.

Parameters:

  • parent (String) —

    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/documentsor projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

  • run_query_request_object (Google::Apis::FirestoreV1beta1::RunQueryRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



609
610
611
612
613
614
615
616
617
618
619
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 609

def run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}:runQuery', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::RunQueryRequest::Representation
  command.request_object = run_query_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::RunQueryResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::WriteResponse

Streams batches of document updates and deletes, in order.

Parameters:

  • database (String) —

    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::FirestoreV1beta1::WriteRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



644
645
646
647
648
649
650
651
652
653
654
 
# File 'generated/google/apis/firestore_v1beta1/service.rb', line 644

def write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+database}/documents:write', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::WriteRequest::Representation
  command.request_object = write_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::WriteResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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