Class TagTemplateFieldName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class TagTemplateFieldName : IResourceName, IEquatable<TagTemplateFieldName>

Resource name for the TagTemplateField resource.

Inheritance

Object > TagTemplateFieldName

Namespace

Google.Cloud.DataCatalog.V1

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tagTemplateIdString

The TagTemplate ID. Must not be null or empty.

fieldIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

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

TagTemplateId

public string TagTemplateId { get; }

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

Property Value
TypeDescription
String

Type

public TagTemplateFieldName.ResourceNameType Type { get; }

The TagTemplateFieldName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TagTemplateFieldName.ResourceNameType

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)

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tagTemplateIdString

The TagTemplate ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tagTemplateIdString

The TagTemplate ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tagTemplateIdString

The TagTemplate ID. Must not be null or empty.

fieldIdString

The Field ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
TagTemplateFieldName

A new instance of TagTemplateFieldName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TagTemplateFieldName Parse(string tagTemplateFieldName)

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

Parameter
NameDescription
tagTemplateFieldNameString

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

Returns
TypeDescription
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, Boolean)

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

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

allowUnparsedBoolean

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
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
TypeDescription
String

The string representation of the resource name.

Overrides

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

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

resultTagTemplateFieldName

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

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
tagTemplateFieldNameString

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

allowUnparsedBoolean

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.

resultTagTemplateFieldName

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

Returns
TypeDescription
Boolean

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

Equality(TagTemplateFieldName, TagTemplateFieldName)

public static bool operator ==(TagTemplateFieldName a, TagTemplateFieldName b)
Parameters
NameDescription
aTagTemplateFieldName
bTagTemplateFieldName
Returns
TypeDescription
Boolean

Inequality(TagTemplateFieldName, TagTemplateFieldName)

public static bool operator !=(TagTemplateFieldName a, TagTemplateFieldName b)
Parameters
NameDescription
aTagTemplateFieldName
bTagTemplateFieldName
Returns
TypeDescription
Boolean