Class: Google::Apis::FirestoreV1beta2::FirestoreService

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

Firestore = Google::Apis::FirestoreV1beta2 # 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

#initializeFirestoreService

Returns a new instance of FirestoreService



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

def initialize
  super('https://firestore.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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_v1beta2/service.rb', line 39

def key
  @key
end

#quota_userString

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_v1beta2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

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

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

Parameters:

  • parent (String)

    A parent name of the form projects/project_id/databases/database_id/collectionGroups/collection_id

  • google_firestore_admin_v1beta2_index_object (Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index) (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:



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

def create_project_database_collection_group_index(parent, google_firestore_admin_v1beta2_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta2/{+parent}/indexes', options)
  command.request_representation = Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index::Representation
  command.request_object = google_firestore_admin_v1beta2_index_object
  command.response_representation = Google::Apis::FirestoreV1beta2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta2::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_collection_group_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta2::Empty

Deletes a composite index.

Parameters:

  • name (String)

    A name of the form projects/project_id/databases/database_id/collectionGroups/collection_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:



343
344
345
346
347
348
349
350
351
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 343

def delete_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta2::Empty::Representation
  command.response_class = Google::Apis::FirestoreV1beta2::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_v1beta2_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta2::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_v1beta2_export_documents_request_object (Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ExportDocumentsRequest) (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_v1beta2/service.rb', line 80

def export_project_database_documents(name, google_firestore_admin_v1beta2_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta2/{+name}:exportDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ExportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1beta2_export_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1beta2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta2::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_collection_group_field(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Field

Gets the metadata and configuration for a Field.

Parameters:

  • name (String)

    A name of the form projects/project_id/databases/database_id/collectionGroups/collection_id /fields/field_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:



152
153
154
155
156
157
158
159
160
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 152

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

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

Gets a composite index.

Parameters:

  • name (String)

    A name of the form projects/project_id/databases/database_id/collectionGroups/collection_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:



375
376
377
378
379
380
381
382
383
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 375

def get_project_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index::Representation
  command.response_class = Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index
  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_v1beta2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta2::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_v1beta2_import_documents_request_object (Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ImportDocumentsRequest) (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_v1beta2/service.rb', line 118

def import_project_database_documents(name, google_firestore_admin_v1beta2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta2/{+name}:importDocuments', options)
  command.request_representation = Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ImportDocumentsRequest::Representation
  command.request_object = google_firestore_admin_v1beta2_import_documents_request_object
  command.response_representation = Google::Apis::FirestoreV1beta2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::FirestoreV1beta2::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_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ListFieldsResponse

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

Parameters:

  • parent (String)

    A parent name of the form projects/project_id/databases/database_id/collectionGroups/collection_id

  • filter (String)

    The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false.

  • page_size (Fixnum)

    The number of results to return.

  • page_token (String)

    A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

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



200
201
202
203
204
205
206
207
208
209
210
211
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 200

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

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

Lists composite indexes.

Parameters:

  • parent (String)

    A parent name of the form projects/project_id/databases/database_id/collectionGroups/collection_id

  • filter (String)

    The filter to apply to list results.

  • page_size (Fixnum)

    The number of results to return.

  • page_token (String)

    A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

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



415
416
417
418
419
420
421
422
423
424
425
426
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 415

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

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

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: paths: "index_config". This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special Field with resource name: projects/project_id/databases/database_id/collectionGroups/__default__/ fields/*.

Parameters:

  • name (String)

    A field name of the form projects/project_id/databases/database_id/collectionGroups/collection_id /fields/field_path A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, (backtick),[,], as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. ``represents a field named, not any field. A specialFieldcontains the default indexing settings for all fields. This field's resource name is: projects/project_id/databases/database_id/collectionGroups/default/ fields/* Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.

  • google_firestore_admin_v1beta2_field_object (Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Field) (defaults to: nil)
  • update_mask (String)

    A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

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



271
272
273
274
275
276
277
278
279
280
281
282
# File 'generated/google/apis/firestore_v1beta2/service.rb', line 271

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