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\u003eThis document provides reference information for the \u003ccode\u003eBackupName\u003c/code\u003e class within the Google Cloud Firestore Admin v1 API, specifically for .NET development.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBackupName\u003c/code\u003e represents a resource name for a backup and can be constructed using a project ID, location ID, and backup ID, conforming to the pattern \u003ccode\u003eprojects/{project}/locations/{location}/backups/{backup}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes methods for formatting, parsing, and validating backup resource names, ensuring proper structure and format.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the API that is reflected in the document is 3.12.0, with previous versions listed down to 2.2.0, all available within the same documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides properties like \u003ccode\u003eProjectId\u003c/code\u003e, \u003ccode\u003eLocationId\u003c/code\u003e, and \u003ccode\u003eBackupId\u003c/code\u003e, enabling access to the individual components of a backup resource name.\u003c/p\u003e\n"]]],[],null,["# Firestore Admin v1 API - Class BackupName (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.BackupName)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.14.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.13.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.12.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.11.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.10.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.9.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.8.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.7.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.6.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.5.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.4.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.3.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.2.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.1.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/3.0.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.4.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.3.0/Google.Cloud.Firestore.Admin.V1.BackupName)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/2.2.0/Google.Cloud.Firestore.Admin.V1.BackupName) \n\n public sealed class BackupName : IResourceName, IEquatable\u003cBackupName\u003e\n\nReference documentation and code samples for the Firestore Admin v1 API class BackupName.\n\nResource name for the `Backup` resource. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BackupName \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)[BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) \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### BackupName(string, string, string)\n\n public BackupName(string projectId, string locationId, string backupId)\n\nConstructs a new instance of a [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) class from the component parts of pattern\n`projects/{project}/locations/{location}/backups/{backup}`\n\nProperties\n----------\n\n### BackupId\n\n public string BackupId { get; }\n\nThe `Backup` 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### LocationId\n\n public string LocationId { get; }\n\nThe `Location` ID. Will not be `null`, unless this instance contains an unparsed resource name.\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 BackupName.ResourceNameType Type { get; }\n\nThe [BackupName.ResourceNameType](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName.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 locationId, string backupId)\n\nFormats the IDs into the string representation of this [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) with pattern\n`projects/{project}/locations/{location}/backups/{backup}`.\n\n### FormatProjectLocationBackup(string, string, string)\n\n public static string FormatProjectLocationBackup(string projectId, string locationId, string backupId)\n\nFormats the IDs into the string representation of this [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) with pattern\n`projects/{project}/locations/{location}/backups/{backup}`.\n\n### FromProjectLocationBackup(string, string, string)\n\n public static BackupName FromProjectLocationBackup(string projectId, string locationId, string backupId)\n\nCreates a [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) with the pattern\n`projects/{project}/locations/{location}/backups/{backup}`.\n\n### FromUnparsed(UnparsedResourceName)\n\n public static BackupName FromUnparsed(UnparsedResourceName unparsedResourceName)\n\nCreates a [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) 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 BackupName Parse(string backupName)\n\nParses the given resource name string into a new [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/locations/{location}/backups/{backup}`\n\n\u003cbr /\u003e\n\n### Parse(string, bool)\n\n public static BackupName Parse(string backupName, bool allowUnparsed)\n\nParses the given resource name string into a new [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) instance; optionally allowing an\nunparseable resource name.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/locations/{location}/backups/{backup}`\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 BackupName)\n\n public static bool TryParse(string backupName, out BackupName result)\n\nTries to parse the given resource name string into a new [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/locations/{location}/backups/{backup}`\n\n\u003cbr /\u003e\n\n### TryParse(string, bool, out BackupName)\n\n public static bool TryParse(string backupName, bool allowUnparsed, out BackupName result)\n\nTries to parse the given resource name string into a new [BackupName](/dotnet/docs/reference/Google.Cloud.Firestore.Admin.V1/latest/Google.Cloud.Firestore.Admin.V1.BackupName) 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}/locations/{location}/backups/{backup}`\n\nOr may be in any format if `allowUnparsed` is `true`.\n\n\u003cbr /\u003e\n\nOperators\n---------\n\n### operator ==(BackupName, BackupName)\n\n public static bool operator ==(BackupName a, BackupName b)\n\nDetermines whether two specified resource names have the same value.\n\n### operator !=(BackupName, BackupName)\n\n public static bool operator !=(BackupName a, BackupName b)\n\nDetermines whether two specified resource names have different values."]]