Data Catalog v1 API - Class TagTemplateFieldName (2.3.0)

Version 2.3.0

• 2.14.0 (latest)
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0

public sealed class TagTemplateFieldName : IResourceName, IEquatable<TagTemplateFieldName>

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

Resource name for the TagTemplateField resource.

Inheritance

object > TagTemplateFieldName

Implements

IResourceName, IEquatableTagTemplateFieldName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DataCatalogV1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagTemplateFieldName(string, string, string, string)

public TagTemplateFieldName(string projectId, string locationId, string tagTemplateId, string fieldId)

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

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.
fieldId	string The Field ID. Must not be null or empty.

Properties

FieldId

public string FieldId { get; }

The Field 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

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 TagTemplateFieldName.ResourceNameType Type { get; }

The TagTemplateFieldName.ResourceNameType of the contained resource name.

Property Value
Type	Description
TagTemplateFieldNameResourceNameType

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)

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

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

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.
fieldId	string The Field ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TagTemplateFieldName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{field}.

FormatProjectLocationTagTemplateField(string, string, string, string)

public static string FormatProjectLocationTagTemplateField(string projectId, string locationId, string tagTemplateId, string fieldId)

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

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.
fieldId	string The Field ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TagTemplateFieldName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{field}.

FromProjectLocationTagTemplateField(string, string, string, string)

public static TagTemplateFieldName FromProjectLocationTagTemplateField(string projectId, string locationId, string tagTemplateId, string fieldId)

Creates a TagTemplateFieldName with the pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{field}.

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.
fieldId	string The Field ID. Must not be null or empty.

Returns
Type	Description
TagTemplateFieldName	A new instance of TagTemplateFieldName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TagTemplateFieldName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TagTemplateFieldName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
TagTemplateFieldName	A new instance of TagTemplateFieldName 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 TagTemplateFieldName Parse(string tagTemplateFieldName)

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

Parameter
Name	Description
tagTemplateFieldName	string The resource name in string form. Must not be null.

Returns
Type	Description
TagTemplateFieldName	The parsed TagTemplateFieldName if successful.

Remarks

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

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

Parse(string, bool)

public static TagTemplateFieldName Parse(string tagTemplateFieldName, bool allowUnparsed)

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

Parameters
Name	Description
tagTemplateFieldName	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
TagTemplateFieldName	The parsed TagTemplateFieldName if successful.

Remarks

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

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

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 TagTemplateFieldName)

public static bool TryParse(string tagTemplateFieldName, out TagTemplateFieldName result)

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

Parameters
Name	Description
tagTemplateFieldName	string The resource name in string form. Must not be null.
result	TagTemplateFieldName When this method returns, the parsed TagTemplateFieldName, 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}/fields/{field}

TryParse(string, bool, out TagTemplateFieldName)

public static bool TryParse(string tagTemplateFieldName, bool allowUnparsed, out TagTemplateFieldName result)

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

Parameters
Name	Description
tagTemplateFieldName	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	TagTemplateFieldName When this method returns, the parsed TagTemplateFieldName, 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}/fields/{field}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagTemplateFieldName, TagTemplateFieldName)

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

Parameters
Name	Description
a	TagTemplateFieldName
b	TagTemplateFieldName

Returns
Type	Description
bool

operator !=(TagTemplateFieldName, TagTemplateFieldName)

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

Parameters
Name	Description
a	TagTemplateFieldName
b	TagTemplateFieldName

Returns
Type	Description
bool