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-09-04 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eApiName\u003c/code\u003e class in the Google.Cloud.ApigeeRegistry.V1 namespace represents the resource name for an \u003ccode\u003eApi\u003c/code\u003e resource within the Apigee Registry v1 API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiName\u003c/code\u003e instances can be constructed using a project ID, location ID, and API ID, following the pattern \u003ccode\u003eprojects/{project}/locations/{location}/apis/{api}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides methods to format, parse, and validate resource names, ensuring they adhere to the correct structure, and also to handle unparsed resource names.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eApiName\u003c/code\u003e objects include \u003ccode\u003eProjectId\u003c/code\u003e, \u003ccode\u003eLocationId\u003c/code\u003e, \u003ccode\u003eApiId\u003c/code\u003e, and \u003ccode\u003eIsKnownPattern\u003c/code\u003e, which allow for access and validation of the component parts of the resource name.\u003c/p\u003e\n"],["\u003cp\u003eThis class also offers methods for string conversion, hash code generation, and equality checks via operators for effective management of resource names.\u003c/p\u003e\n"]]],[],null,["# Apigee Registry v1 API - Class ApiName (1.0.0-beta07)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta07 (latest)](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/1.0.0-beta06/Google.Cloud.ApigeeRegistry.V1.ApiName) \n\n public sealed class ApiName : IResourceName, IEquatable\u003cApiName\u003e\n\nReference documentation and code samples for the Apigee Registry v1 API class ApiName.\n\nResource name for the `Api` resource. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ApiName \n\nImplements\n----------\n\n[IResourceName](https://github.com/googleapis/gax-dotnet/blob/83f42b5edc4529818dbdb34d9ea9ecc3c04f7b6e/Google.Api.Gax/IResourceName.cs), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) \n\nInherited Members\n-----------------\n\n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)\n\nNamespace\n---------\n\n[Google.Cloud.ApigeeRegistry.V1](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.ApigeeRegistry.V1.dll\n\nConstructors\n------------\n\n### ApiName(string, string, string)\n\n public ApiName(string projectId, string locationId, string apiId)\n\nConstructs a new instance of a [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) class from the component parts of pattern\n`projects/{project}/locations/{location}/apis/{api}`\n\nProperties\n----------\n\n### ApiId\n\n public string ApiId { get; }\n\nThe `Api` 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 ApiName.ResourceNameType Type { get; }\n\nThe [ApiName.ResourceNameType](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName.ResourceNameType) of the contained resource name.\n\n### UnparsedResource\n\n public UnparsedResourceName UnparsedResource { get; }\n\nThe contained [UnparsedResourceName](https://github.com/googleapis/gax-dotnet/blob/83f42b5edc4529818dbdb34d9ea9ecc3c04f7b6e/Google.Api.Gax/UnparsedResourceName.cs). 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 apiId)\n\nFormats the IDs into the string representation of this [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) with pattern\n`projects/{project}/locations/{location}/apis/{api}`.\n\n### FormatProjectLocationApi(string, string, string)\n\n public static string FormatProjectLocationApi(string projectId, string locationId, string apiId)\n\nFormats the IDs into the string representation of this [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) with pattern\n`projects/{project}/locations/{location}/apis/{api}`.\n\n### FromProjectLocationApi(string, string, string)\n\n public static ApiName FromProjectLocationApi(string projectId, string locationId, string apiId)\n\nCreates a [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) with the pattern `projects/{project}/locations/{location}/apis/{api}`.\n\n### FromUnparsed(UnparsedResourceName)\n\n public static ApiName FromUnparsed(UnparsedResourceName unparsedResourceName)\n\nCreates a [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) 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 ApiName Parse(string apiName)\n\nParses the given resource name string into a new [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/locations/{location}/apis/{api}`\n\n\u003cbr /\u003e\n\n### Parse(string, bool)\n\n public static ApiName Parse(string apiName, bool allowUnparsed)\n\nParses the given resource name string into a new [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) 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}/apis/{api}`\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 ApiName)\n\n public static bool TryParse(string apiName, out ApiName result)\n\nTries to parse the given resource name string into a new [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) instance.\n\n**Remarks** \nTo parse successfully, the resource name must be formatted as one of the following:\n\n- `projects/{project}/locations/{location}/apis/{api}`\n\n\u003cbr /\u003e\n\n### TryParse(string, bool, out ApiName)\n\n public static bool TryParse(string apiName, bool allowUnparsed, out ApiName result)\n\nTries to parse the given resource name string into a new [ApiName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiName) instance; optionally allowing\nan 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}/apis/{api}`\n\nOr may be in any format if `allowUnparsed` is `true`.\n\n\u003cbr /\u003e\n\nOperators\n---------\n\n### operator ==(ApiName, ApiName)\n\n public static bool operator ==(ApiName a, ApiName b)\n\nDetermines whether two specified resource names have the same value.\n\n### operator !=(ApiName, ApiName)\n\n public static bool operator !=(ApiName a, ApiName b)\n\nDetermines whether two specified resource names have different values."]]
