Data Catalog v1 API - Class TagName (2.8.0)

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.

Inheritance

object > TagName

Namespace

Google.Cloud.DataCatalog.V1

Assembly

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

entryGroupIdstring

The EntryGroup ID. Must not be null or empty.

entryIdstring

The Entry ID. Must not be null or empty.

tagIdstring

The Tag ID. Must not be null or empty.

Properties

EntryGroupId

public string EntryGroupId { get; }

The EntryGroup ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

EntryId

public string EntryId { get; }

The Entry ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

TagId

public string TagId { get; }

The Tag ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

Type

public TagName.ResourceNameType Type { get; }

The TagName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TagNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

entryGroupIdstring

The EntryGroup ID. Must not be null or empty.

entryIdstring

The Entry ID. Must not be null or empty.

tagIdstring

The Tag ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TagName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}.

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

entryGroupIdstring

The EntryGroup ID. Must not be null or empty.

entryIdstring

The Entry ID. Must not be null or empty.

tagIdstring

The Tag ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TagName with pattern projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}.

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

entryGroupIdstring

The EntryGroup ID. Must not be null or empty.

entryIdstring

The Entry ID. Must not be null or empty.

tagIdstring

The Tag ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TagName

A new instance of TagName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TagName Parse(string tagName)

Parses the given resource name string into a new TagName instance.

Parameter
NameDescription
tagNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
TagName

The parsed TagName if successful.

Remarks

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
NameDescription
tagNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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.

Returns
TypeDescription
TagName

The parsed TagName if successful.

Remarks

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}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

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
NameDescription
tagNamestring

The resource name in string form. Must not be null.

resultTagName

When this method returns, the parsed TagName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

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
NameDescription
tagNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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.

resultTagName

When this method returns, the parsed TagName, or null if parsing failed.

Returns
TypeDescription
bool

true if the name was parsed successfully; false otherwise.

Remarks

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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagName, TagName)

public static bool operator ==(TagName a, TagName b)
Parameters
NameDescription
aTagName
bTagName
Returns
TypeDescription
bool

operator !=(TagName, TagName)

public static bool operator !=(TagName a, TagName b)
Parameters
NameDescription
aTagName
bTagName
Returns
TypeDescription
bool