Reference documentation and code samples for the Firestore Admin v1 API class FirestoreAdmin.
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are
used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is performed asynchronously.
An Operation resource is created for each such asynchronous operation.
The state of the operation (including any errors encountered)
may be queried via the Operation resource.
The Operations collection provides a record of actions performed for the
specified Project (including any Operations in progress). Operations are not
created directly but through calls on other collections or resources.
An Operation that is done may be deleted so that it is no longer listed as
part of the Operation collection. Operations are garbage collected after
30 days. By default, ListOperations will only return in progress and failed
operations. To list completed operation, issue a ListOperations request with
the filter done: true.
Operations are created by service FirestoreAdmin, but are accessed via
service google.longrunning.Operations.
public static void BindService(ServiceBinderBase serviceBinder, FirestoreAdmin.FirestoreAdminBase serviceImpl)
Register service method with a service binder with or without implementation. Useful when customizing the service binding logic.
Note: this method is part of an experimental API that can change or be removed without any prior notice.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference documentation for the \u003ccode\u003eFirestoreAdmin\u003c/code\u003e class within the Google Cloud Firestore Admin v1 API, specifically for .NET development.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFirestoreAdmin\u003c/code\u003e API class offers administrative services for Cloud Firestore, covering aspects like managing projects, databases, namespaces, collections, and documents.\u003c/p\u003e\n"],["\u003cp\u003eThe API utilizes Operations for asynchronous tasks, like index creation, which can be tracked through an Operation resource.\u003c/p\u003e\n"],["\u003cp\u003eThe document lists the available versions of the API from 2.2.0 up to the latest version 3.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFirestoreAdmin\u003c/code\u003e class provides methods to bind the service, including \u003ccode\u003eBindService(FirestoreAdminBase)\u003c/code\u003e and \u003ccode\u003eBindService(ServiceBinderBase, FirestoreAdminBase)\u003c/code\u003e, for server-side handling logic.\u003c/p\u003e\n"]]],[],null,["# Firestore Admin v1 API - Class FirestoreAdmin (3.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.15.0 (latest)](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.14.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.13.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.12.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.11.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.10.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.9.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.8.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.7.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.6.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.5.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.4.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.3.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.2.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.1.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.0.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.4.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.3.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.2.0/Google.Cloud.Firestore.Admin.V1.FirestoreAdmin) \n\n public static class FirestoreAdmin\n\nReference documentation and code samples for the Firestore Admin v1 API class FirestoreAdmin.\n\nThe Cloud Firestore Admin API.\n\nThis API provides several administrative services for Cloud Firestore.\n\nProject, Database, Namespace, Collection, Collection Group, and Document are\nused as defined in the Google Cloud Firestore API.\n\nOperation: An Operation represents work being performed in the background.\n\nThe index service manages Cloud Firestore indexes.\n\nIndex creation is performed asynchronously.\nAn Operation resource is created for each such asynchronous operation.\nThe state of the operation (including any errors encountered)\nmay be queried via the Operation resource.\n\nThe Operations collection provides a record of actions performed for the\nspecified Project (including any Operations in progress). Operations are not\ncreated directly but through calls on other collections or resources.\n\nAn Operation that is done may be deleted so that it is no longer listed as\npart of the Operation collection. Operations are garbage collected after\n30 days. By default, ListOperations will only return in progress and failed\noperations. To list completed operation, issue a ListOperations request with\nthe filter `done: true`.\n\nOperations are created by service `FirestoreAdmin`, but are accessed via\nservice `google.longrunning.Operations`. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e FirestoreAdmin \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Firestore.Admin.V1](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Firestore.Admin.V1.dll\n\nMethods\n-------\n\n### BindService(FirestoreAdminBase)\n\n public static ServerServiceDefinition BindService(FirestoreAdmin.FirestoreAdminBase serviceImpl)\n\nCreates service definition that can be registered with a server\n\n### BindService(ServiceBinderBase, FirestoreAdminBase)\n\n public static void BindService(ServiceBinderBase serviceBinder, FirestoreAdmin.FirestoreAdminBase serviceImpl)\n\nRegister service method with a service binder with or without implementation. Useful when customizing the service binding logic.\nNote: this method is part of an experimental API that can change or be removed without any prior notice."]]
