public CollectionGroupName(string projectId, string databaseId, string collectionId)
Constructs a new instance of a CollectionGroupName class from the component parts of pattern
projects/{project}/databases/{database}/collectionGroups/{collection}
public static string Format(string projectId, string databaseId, string collectionId)
Formats the IDs into the string representation of this CollectionGroupName with pattern
projects/{project}/databases/{database}/collectionGroups/{collection}.
public static string FormatProjectDatabaseCollection(string projectId, string databaseId, string collectionId)
Formats the IDs into the string representation of this CollectionGroupName with pattern
projects/{project}/databases/{database}/collectionGroups/{collection}.
If true will successfully store an unparseable resource name into the UnparsedResource
property; otherwise will throw an ArgumentException if an unparseable resource name is
specified.
If true will successfully store an unparseable resource name into the UnparsedResource
property; otherwise will throw an ArgumentException if an unparseable resource name is
specified.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eCollectionGroupName\u003c/code\u003e class in the Google Cloud Firestore Admin v1 API represents the resource name for a CollectionGroup.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides methods for constructing, formatting, parsing, and validating resource names based on the pattern \u003ccode\u003eprojects/{project}/databases/{database}/collectionGroups/{collection}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available is 3.12.0, and the webpage provides access to versions ranging from 2.2.0 to 3.12.0, each version linking to its corresponding documentation.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCollectionGroupName\u003c/code\u003e instances contain information such as Project ID, Database ID, and Collection ID, and properties such as \u003ccode\u003eIsKnownPattern\u003c/code\u003e, \u003ccode\u003eType\u003c/code\u003e and \u003ccode\u003eUnparsedResource\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCollectionGroupName\u003c/code\u003e Implements the interfaces \u003ccode\u003eIResourceName\u003c/code\u003e, and \u003ccode\u003eIEquatable<CollectionGroupName>\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Firestore Admin v1 API - Class CollectionGroupName (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.CollectionGroupName)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.14.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.13.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.12.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.11.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.10.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.9.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.8.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.7.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.6.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.5.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.4.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.3.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.2.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.1.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.0.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.4.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.3.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.2.0/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) \n\n public sealed class CollectionGroupName : IResourceName, IEquatable\u003cCollectionGroupName\u003e\n\nReference documentation and code samples for the Firestore Admin v1 API class CollectionGroupName.\n\nResource name for the `CollectionGroup` resource. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e CollectionGroupName \n\nImplements\n----------\n\n[IResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) \n\nInherited Members\n-----------------\n\n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)\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\nConstructors\n------------\n\n### CollectionGroupName(string, string, string)\n\n public CollectionGroupName(string projectId, string databaseId, string collectionId)\n\nConstructs a new instance of a [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) class from the component parts of pattern\n`projects/{project}/databases/{database}/collectionGroups/{collection}`\n\nProperties\n----------\n\n### CollectionId\n\n public string CollectionId { get; }\n\nThe `Collection` ID. Will not be `null`, unless this instance contains an unparsed resource name.\n\n### DatabaseId\n\n public string DatabaseId { get; }\n\nThe `Database` ID. Will not be `null`, unless this instance contains an unparsed resource name.\n\n### IsKnownPattern\n\n public bool IsKnownPattern { get; }\n\nWhether this instance contains a resource name with a known pattern.\n\n### ProjectId\n\n public string ProjectId { get; }\n\nThe `Project` ID. Will not be `null`, unless this instance contains an unparsed resource name.\n\n### Type\n\n public CollectionGroupName.ResourceNameType Type { get; }\n\nThe [CollectionGroupName.ResourceNameType](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName.ResourceNameType) of the contained resource name.\n\n### UnparsedResource\n\n public UnparsedResourceName UnparsedResource { get; }\n\nThe contained [UnparsedResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html). Only non-`null` if this instance contains an\nunparsed resource name.\n\nMethods\n-------\n\n### Format(string, string, string)\n\n public static string Format(string projectId, string databaseId, string collectionId)\n\nFormats the IDs into the string representation of this [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) with pattern\n`projects/{project}/databases/{database}/collectionGroups/{collection}`.\n\n### FormatProjectDatabaseCollection(string, string, string)\n\n public static string FormatProjectDatabaseCollection(string projectId, string databaseId, string collectionId)\n\nFormats the IDs into the string representation of this [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) with pattern\n`projects/{project}/databases/{database}/collectionGroups/{collection}`.\n\n### FromProjectDatabaseCollection(string, string, string)\n\n public static CollectionGroupName FromProjectDatabaseCollection(string projectId, string databaseId, string collectionId)\n\nCreates a [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) with the pattern\n`projects/{project}/databases/{database}/collectionGroups/{collection}`.\n\n### FromUnparsed(UnparsedResourceName)\n\n public static CollectionGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)\n\nCreates a [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) containing an unparsed resource name.\n\n### GetHashCode()\n\n public override int GetHashCode()\n\nReturns a hash code for this resource name.\n\n**Overrides** \n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)\n\n### Parse(string)\n\n public static CollectionGroupName Parse(string collectionGroupName)\n\nParses the given resource name string into a new [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/databases/{database}/collectionGroups/{collection}`\n\n\u003cbr /\u003e\n\n### Parse(string, bool)\n\n public static CollectionGroupName Parse(string collectionGroupName, bool allowUnparsed)\n\nParses the given resource name string into a new [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) instance; optionally\nallowing an unparseable resource name.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/databases/{database}/collectionGroups/{collection}`\n\nOr may be in any format if `allowUnparsed` is `true`.\n\n\u003cbr /\u003e\n\n### ToString()\n\n public override string ToString()\n\nThe string representation of the resource name.\n\n**Overrides** \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\n### TryParse(string, out CollectionGroupName)\n\n public static bool TryParse(string collectionGroupName, out CollectionGroupName result)\n\nTries to parse the given resource name string into a new [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/databases/{database}/collectionGroups/{collection}`\n\n\u003cbr /\u003e\n\n### TryParse(string, bool, out CollectionGroupName)\n\n public static bool TryParse(string collectionGroupName, bool allowUnparsed, out CollectionGroupName result)\n\nTries to parse the given resource name string into a new [CollectionGroupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.CollectionGroupName) instance;\noptionally allowing an unparseable resource name.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/databases/{database}/collectionGroups/{collection}`\n\nOr may be in any format if `allowUnparsed` is `true`.\n\n\u003cbr /\u003e\n\nOperators\n---------\n\n### operator ==(CollectionGroupName, CollectionGroupName)\n\n public static bool operator ==(CollectionGroupName a, CollectionGroupName b)\n\nDetermines whether two specified resource names have the same value.\n\n### operator !=(CollectionGroupName, CollectionGroupName)\n\n public static bool operator !=(CollectionGroupName a, CollectionGroupName b)\n\nDetermines whether two specified resource names have different values."]]
