Show / Hide Table of Contents

Class ProjectsResource.DatabasesResource

The "databases" collection of methods.

Inheritance
object
ProjectsResource.DatabasesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1beta1
Assembly: Google.Apis.Firestore.v1beta1.dll
Syntax
public class ProjectsResource.DatabasesResource

Constructors

DatabasesResource(IClientService)

Constructs a new resource.

Declaration
public DatabasesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Documents

Gets the Documents resource.

Declaration
public virtual ProjectsResource.DatabasesResource.DocumentsResource Documents { get; }
Property Value
Type Description
ProjectsResource.DatabasesResource.DocumentsResource

Indexes

Gets the Indexes resource.

Declaration
public virtual ProjectsResource.DatabasesResource.IndexesResource Indexes { get; }
Property Value
Type Description
ProjectsResource.DatabasesResource.IndexesResource

Methods

ExportDocuments(GoogleFirestoreAdminV1beta1ExportDocumentsRequest, string)

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.

Declaration
public virtual ProjectsResource.DatabasesResource.ExportDocumentsRequest ExportDocuments(GoogleFirestoreAdminV1beta1ExportDocumentsRequest body, string name)
Parameters
Type Name Description
GoogleFirestoreAdminV1beta1ExportDocumentsRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.DatabasesResource.ExportDocumentsRequest

ImportDocuments(GoogleFirestoreAdminV1beta1ImportDocumentsRequest, string)

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.

Declaration
public virtual ProjectsResource.DatabasesResource.ImportDocumentsRequest ImportDocuments(GoogleFirestoreAdminV1beta1ImportDocumentsRequest body, string name)
Parameters
Type Name Description
GoogleFirestoreAdminV1beta1ImportDocumentsRequest body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.DatabasesResource.ImportDocumentsRequest
In this article
Back to top Generated by DocFX