Data Catalog v1 API - Class TagTemplateName (2.13.0)

public sealed class TagTemplateName : IResourceName, IEquatable<TagTemplateName>

Reference documentation and code samples for the Data Catalog v1 API class TagTemplateName.

Resource name for the TagTemplate resource.

Inheritance

object > TagTemplateName

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagTemplateName(string, string, string)

public TagTemplateName(string projectId, string locationId, string tagTemplateId)

Constructs a new instance of a TagTemplateName class from the component parts of pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}

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.

tagTemplateId string

The TagTemplate ID. Must not be null or empty.

Properties

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

TagTemplateId

public string TagTemplateId { get; }

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

Property Value
Type Description
string

Type

public TagTemplateName.ResourceNameType Type { get; }

The TagTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
TagTemplateNameResourceNameType

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)

public static string Format(string projectId, string locationId, string tagTemplateId)

Formats the IDs into the string representation of this TagTemplateName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}.

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.

tagTemplateId string

The TagTemplate ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TagTemplateName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}.

FormatProjectLocationTagTemplate(string, string, string)

public static string FormatProjectLocationTagTemplate(string projectId, string locationId, string tagTemplateId)

Formats the IDs into the string representation of this TagTemplateName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}.

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.

tagTemplateId string

The TagTemplate ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TagTemplateName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}.

FromProjectLocationTagTemplate(string, string, string)

public static TagTemplateName FromProjectLocationTagTemplate(string projectId, string locationId, string tagTemplateId)

Creates a TagTemplateName with the pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}.

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.

tagTemplateId string

The TagTemplate ID. Must not be null or empty.

Returns
Type Description
TagTemplateName

A new instance of TagTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TagTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TagTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TagTemplateName

A new instance of TagTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TagTemplateName Parse(string tagTemplateName)

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

Parameter
Name Description
tagTemplateName string

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

Returns
Type Description
TagTemplateName

The parsed TagTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/tagTemplates/{tag_template}

Parse(string, bool)

public static TagTemplateName Parse(string tagTemplateName, bool allowUnparsed)

Parses the given resource name string into a new TagTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
tagTemplateName 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
TagTemplateName

The parsed TagTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/tagTemplates/{tag_template}
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

TryParse(string, out TagTemplateName)

public static bool TryParse(string tagTemplateName, out TagTemplateName result)

Tries to parse the given resource name string into a new TagTemplateName instance.

Parameters
Name Description
tagTemplateName string

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

result TagTemplateName

When this method returns, the parsed TagTemplateName, 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}/tagTemplates/{tag_template}

TryParse(string, bool, out TagTemplateName)

public static bool TryParse(string tagTemplateName, bool allowUnparsed, out TagTemplateName result)

Tries to parse the given resource name string into a new TagTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
tagTemplateName 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 TagTemplateName

When this method returns, the parsed TagTemplateName, 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}/tagTemplates/{tag_template}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagTemplateName, TagTemplateName)

public static bool operator ==(TagTemplateName a, TagTemplateName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TagTemplateName

The first resource name to compare, or null.

b TagTemplateName

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 !=(TagTemplateName, TagTemplateName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TagTemplateName

The first resource name to compare, or null.

b TagTemplateName

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.