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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FirestoreService

Returns a new instance of FirestoreService.



48
49
50
51
52
53
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 48

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

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



41
42
43
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

Instance Method Details

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



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 194

def batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+database}/documents:batchWrite', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::BatchWriteRequest::Representation
  command.request_object = batch_write_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::BatchWriteResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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::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) —

    Required. 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) (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



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 156

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

    Required. 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) (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



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 228

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

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

  • commit_request_object (Google::Apis::FirestoreV1beta1::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



262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 262

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

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



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

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



885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 885

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

    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



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

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



918
919
920
921
922
923
924
925
926
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 918

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) (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_v1beta1/service.rb', line 83

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

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

  • mask_field_paths (Array<String>, String) (defaults to: nil) —

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

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

    Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

  • 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



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

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



949
950
951
952
953
954
955
956
957
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 949

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



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 121

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

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



501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 501

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

Lists documents.

Parameters:

  • parent (String) —

    Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`

  • collection_id (String) —

    Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

  • mask_field_paths (Array<String>, String) (defaults to: nil) —

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

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

    Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.

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

    Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.

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

    Optional. A page token, received from a previous ListDocuments response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.

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

    Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

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

    If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set. Requests with show_missing may not specify where or order_by.

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

    Perform the read as part of an already active transaction.

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

    Selector specifying which fields to include in a partial response.

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

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

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
580
581
582
583
584
585
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 569

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

    Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`

  • collection_id (String) —

    Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.

  • mask_field_paths (Array<String>, String) (defaults to: nil) —

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

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

    Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.

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

    Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.

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

    Optional. A page token, received from a previous ListDocuments response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of page_size) must match the values set in the request that generated the page token.

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

    Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

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

    If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set. Requests with show_missing may not specify where or order_by.

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

    Perform the read as part of an already active transaction.

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

    Selector specifying which fields to include in a partial response.

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

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 460

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) (defaults to: nil)
  • 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



984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 984

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. This method is only available via gRPC or WebChannel (not REST).

Parameters:

  • database (String) —

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

  • listen_request_object (Google::Apis::FirestoreV1beta1::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



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

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

#partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::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



647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 647

def partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:partitionQuery', options)
  command.request_representation = Google::Apis::FirestoreV1beta1::PartitionQueryRequest::Representation
  command.request_object = partition_query_request_object
  command.response_representation = Google::Apis::FirestoreV1beta1::PartitionQueryResponse::Representation
  command.response_class = Google::Apis::FirestoreV1beta1::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_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) (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



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 693

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

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

  • rollback_request_object (Google::Apis::FirestoreV1beta1::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



731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 731

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_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse

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

Parameters:

  • parent (String) —

    Required. The parent resource name. In the format: projects/project_id/ databases/database_id/documents or projects/project_id/databases/ database_id/documents/document_path`. For example:projects/my-project/ databases/my-database/documentsorprojects/my-project/databases/my-database/ documents/chatrooms/my-chatroom`

  • run_aggregation_query_request_object (Google::Apis::FirestoreV1beta1::RunAggregationQueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

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



772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 772

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

#run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta1::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::FirestoreV1beta1::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



809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 809

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. This method is only available via gRPC or WebChannel (not REST).

Parameters:

  • database (String) —

    Required. The database name. In the format: projects/project_id/databases/ database_id``. This is only required in the first message.

  • write_request_object (Google::Apis::FirestoreV1beta1::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



844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/google/apis/firestore_v1beta1/service.rb', line 844

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