public sealed class TagName : IResourceName, IEquatable<TagName>
Reference documentation and code samples for the Data Catalog v1 API class TagName.
Resource name for the Tag
resource.
Namespace
GoogleCloudGoogle.Cloud.DataCatalogV1Assembly
Google.Cloud.DataCatalog.V1.dll
Constructors
TagName(string, string, string, string, string)
public TagName(string projectId, string locationId, string entryGroupId, string entryId, string tagId)
Constructs a new instance of a TagName class from the component parts of pattern
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
entryGroupId | string The |
entryId | string The |
tagId | string The |
Properties
EntryGroupId
public string EntryGroupId { get; }
The EntryGroup
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
EntryId
public string EntryId { get; }
The Entry
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
bool |
LocationId
public string LocationId { get; }
The Location
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
TagId
public string TagId { get; }
The Tag
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public TagName.ResourceNameType Type { get; }
The TagName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
TagNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
UnparsedResourceName |
Methods
Format(string, string, string, string, string)
public static string Format(string projectId, string locationId, string entryGroupId, string entryId, string tagId)
Formats the IDs into the string representation of this TagName with pattern
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
entryGroupId | string The |
entryId | string The |
tagId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TagName with pattern
|
FormatProjectLocationEntryGroupEntryTag(string, string, string, string, string)
public static string FormatProjectLocationEntryGroupEntryTag(string projectId, string locationId, string entryGroupId, string entryId, string tagId)
Formats the IDs into the string representation of this TagName with pattern
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
entryGroupId | string The |
entryId | string The |
tagId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TagName with pattern
|
FromProjectLocationEntryGroupEntryTag(string, string, string, string, string)
public static TagName FromProjectLocationEntryGroupEntryTag(string projectId, string locationId, string entryGroupId, string entryId, string tagId)
Creates a TagName with the pattern
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
entryGroupId | string The |
entryId | string The |
tagId | string The |
Returns | |
---|---|
Type | Description |
TagName | A new instance of TagName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static TagName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a TagName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
TagName | A new instance of TagName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static TagName Parse(string tagName)
Parses the given resource name string into a new TagName instance.
Parameter | |
---|---|
Name | Description |
tagName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
TagName | The parsed TagName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
Parse(string, bool)
public static TagName Parse(string tagName, bool allowUnparsed)
Parses the given resource name string into a new TagName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
tagName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
TagName | The parsed TagName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
allowUnparsed
is true
.
ToString()
public override string ToString()
The string representation of the resource name.
Returns | |
---|---|
Type | Description |
string | The string representation of the resource name. |
TryParse(string, out TagName)
public static bool TryParse(string tagName, out TagName result)
Tries to parse the given resource name string into a new TagName instance.
Parameters | |
---|---|
Name | Description |
tagName | string The resource name in string form. Must not be |
result | TagName When this method returns, the parsed TagName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
TryParse(string, bool, out TagName)
public static bool TryParse(string tagName, bool allowUnparsed, out TagName result)
Tries to parse the given resource name string into a new TagName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
tagName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | TagName When this method returns, the parsed TagName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}
allowUnparsed
is true
.
Operators
operator ==(TagName, TagName)
public static bool operator ==(TagName a, TagName b)
Parameters | |
---|---|
Name | Description |
a | TagName |
b | TagName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(TagName, TagName)
public static bool operator !=(TagName a, TagName b)
Parameters | |
---|---|
Name | Description |
a | TagName |
b | TagName |
Returns | |
---|---|
Type | Description |
bool |