Data Catalog v1 API - Class TagName (2.14.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

Implements

IResourceName, IEquatable TagName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entryGroupId`	`string` The `EntryGroup` ID. Must not be `null` or empty.
`entryId`	`string` The `Entry` ID. Must not be `null` or empty.
`tagId`	`string` 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
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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entryGroupId`	`string` The `EntryGroup` ID. Must not be `null` or empty.
`entryId`	`string` The `Entry` ID. Must not be `null` or empty.
`tagId`	`string` The `Tag` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entryGroupId`	`string` The `EntryGroup` ID. Must not be `null` or empty.
`entryId`	`string` The `Entry` ID. Must not be `null` or empty.
`tagId`	`string` The `Tag` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`entryGroupId`	`string` The `EntryGroup` ID. Must not be `null` or empty.
`entryId`	`string` The `Entry` ID. Must not be `null` or empty.
`tagId`	`string` The `Tag` ID. Must not be `null` or empty.

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 `null`.

Returns
Type	Description
`TagName`	A new instance of TagName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

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 `null`.

Returns
Type	Description
`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
Name	Description
`tagName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
Type	Description
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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 `null`.
`result`	`TagName` When this method returns, the parsed TagName, or `null` if parsing failed.

Returns
Type	Description
`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
Name	Description
`tagName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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.
`result`	`TagName` When this method returns, the parsed TagName, or `null` if parsing failed.

Returns
Type	Description
`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)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TagName` The first resource name to compare, or null.
`b`	`TagName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(TagName, TagName)

public static bool operator !=(TagName a, TagName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TagName` The first resource name to compare, or null.
`b`	`TagName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.