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

Assembly: Google.Apis.Firestore.v1.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

BackupSchedules

Gets the BackupSchedules resource.

Declaration

public virtual ProjectsResource.DatabasesResource.BackupSchedulesResource BackupSchedules { get; }

Property Value

Type	Description
ProjectsResource.DatabasesResource.BackupSchedulesResource

CollectionGroups

Gets the CollectionGroups resource.

Declaration

public virtual ProjectsResource.DatabasesResource.CollectionGroupsResource CollectionGroups { get; }

Property Value

Type	Description
ProjectsResource.DatabasesResource.CollectionGroupsResource

Documents

Gets the Documents resource.

Declaration

public virtual ProjectsResource.DatabasesResource.DocumentsResource Documents { get; }

Property Value

Type	Description
ProjectsResource.DatabasesResource.DocumentsResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.DatabasesResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.DatabasesResource.OperationsResource

UserCreds

Gets the UserCreds resource.

Declaration

public virtual ProjectsResource.DatabasesResource.UserCredsResource UserCreds { get; }

Property Value

Type	Description
ProjectsResource.DatabasesResource.UserCredsResource

Methods

BulkDeleteDocuments(GoogleFirestoreAdminV1BulkDeleteDocumentsRequest, string)

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

Declaration

public virtual ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest BulkDeleteDocuments(GoogleFirestoreAdminV1BulkDeleteDocumentsRequest body, string name)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1BulkDeleteDocumentsRequest	body	The body of the request.
string	name	Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.

Returns

Type	Description
ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest

Create(GoogleFirestoreAdminV1Database, string)

Create a database.

Declaration

public virtual ProjectsResource.DatabasesResource.CreateRequest Create(GoogleFirestoreAdminV1Database body, string parent)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1Database	body	The body of the request.
string	parent	Required. A parent name of the form projects/{project_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.CreateRequest

Delete(string)

Deletes a database.

Declaration

public virtual ProjectsResource.DatabasesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. A name of the form projects/{project_id}/databases/{database_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.DeleteRequest

ExportDocuments(GoogleFirestoreAdminV1ExportDocumentsRequest, 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. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import

Declaration

public virtual ProjectsResource.DatabasesResource.ExportDocumentsRequest ExportDocuments(GoogleFirestoreAdminV1ExportDocumentsRequest body, string name)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1ExportDocumentsRequest	body	The body of the request.
string	name	Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}.

Returns

Type	Description
ProjectsResource.DatabasesResource.ExportDocumentsRequest

Get(string)

Gets information about a database.

Declaration

public virtual ProjectsResource.DatabasesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. A name of the form projects/{project_id}/databases/{database_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.GetRequest

ImportDocuments(GoogleFirestoreAdminV1ImportDocumentsRequest, 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(GoogleFirestoreAdminV1ImportDocumentsRequest body, string name)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1ImportDocumentsRequest	body	The body of the request.
string	name	Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

Returns

Type	Description
ProjectsResource.DatabasesResource.ImportDocumentsRequest

List(string)

List all the databases in the project.

Declaration

public virtual ProjectsResource.DatabasesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. A parent name of the form projects/{project_id}

Returns

Type	Description
ProjectsResource.DatabasesResource.ListRequest

Patch(GoogleFirestoreAdminV1Database, string)

Updates a database.

Declaration

public virtual ProjectsResource.DatabasesResource.PatchRequest Patch(GoogleFirestoreAdminV1Database body, string name)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1Database	body	The body of the request.
string	name	The resource name of the Database. Format: projects/{project}/databases/{database}

Returns

Type	Description
ProjectsResource.DatabasesResource.PatchRequest

Restore(GoogleFirestoreAdminV1RestoreDatabaseRequest, string)

Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.

Declaration

public virtual ProjectsResource.DatabasesResource.RestoreRequest Restore(GoogleFirestoreAdminV1RestoreDatabaseRequest body, string parent)

Parameters

Type	Name	Description
GoogleFirestoreAdminV1RestoreDatabaseRequest	body	The body of the request.
string	parent	Required. The project to restore the database in. Format is projects/{project_id}.

Returns

Type	Description
ProjectsResource.DatabasesResource.RestoreRequest