Class TagTemplateFieldEnumValueName (2.1.0)

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

Resource name for the TagTemplateFieldEnumValue resource.

Inheritance

Object > TagTemplateFieldEnumValueName

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

TagTemplateFieldEnumValueName(String, String, String, String, String)

public TagTemplateFieldEnumValueName(string projectId, string locationId, string tagTemplateId, string tagTemplateFieldId, string enumValueDisplayNameId)

Constructs a new instance of a TagTemplateFieldEnumValueName class from the component parts of pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}

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.

tagTemplateFieldIdString

The TagTemplateField ID. Must not be null or empty.

enumValueDisplayNameIdString

The EnumValueDisplayName ID. Must not be null or empty.

Properties

EnumValueDisplayNameId

public string EnumValueDisplayNameId { get; }

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

TagTemplateFieldId

public string TagTemplateFieldId { get; }

The TagTemplateField 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 TagTemplateFieldEnumValueName.ResourceNameType Type { get; }

The TagTemplateFieldEnumValueName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TagTemplateFieldEnumValueName.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, String)

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

Formats the IDs into the string representation of this TagTemplateFieldEnumValueName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name} .

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.

tagTemplateFieldIdString

The TagTemplateField ID. Must not be null or empty.

enumValueDisplayNameIdString

The EnumValueDisplayName ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TagTemplateFieldEnumValueName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name} .

FormatProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName(String, String, String, String, String)

public static string FormatProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName(string projectId, string locationId, string tagTemplateId, string tagTemplateFieldId, string enumValueDisplayNameId)

Formats the IDs into the string representation of this TagTemplateFieldEnumValueName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name} .

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.

tagTemplateFieldIdString

The TagTemplateField ID. Must not be null or empty.

enumValueDisplayNameIdString

The EnumValueDisplayName ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TagTemplateFieldEnumValueName with pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name} .

FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName(String, String, String, String, String)

public static TagTemplateFieldEnumValueName FromProjectLocationTagTemplateTagTemplateFieldEnumValueDisplayName(string projectId, string locationId, string tagTemplateId, string tagTemplateFieldId, string enumValueDisplayNameId)

Creates a TagTemplateFieldEnumValueName with the pattern projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name} .

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.

tagTemplateFieldIdString

The TagTemplateField ID. Must not be null or empty.

enumValueDisplayNameIdString

The EnumValueDisplayName ID. Must not be null or empty.

Returns
TypeDescription
TagTemplateFieldEnumValueName

A new instance of TagTemplateFieldEnumValueName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TagTemplateFieldEnumValueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TagTemplateFieldEnumValueName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TagTemplateFieldEnumValueName

A new instance of TagTemplateFieldEnumValueName 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 TagTemplateFieldEnumValueName Parse(string tagTemplateFieldEnumValueName)

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

Parameter
NameDescription
tagTemplateFieldEnumValueNameString

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

Returns
TypeDescription
TagTemplateFieldEnumValueName

The parsed TagTemplateFieldEnumValueName 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/{tag_template_field_id}/enumValues/{enum_value_display_name}

Parse(String, Boolean)

public static TagTemplateFieldEnumValueName Parse(string tagTemplateFieldEnumValueName, bool allowUnparsed)

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

Parameters
NameDescription
tagTemplateFieldEnumValueNameString

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
TagTemplateFieldEnumValueName

The parsed TagTemplateFieldEnumValueName 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/{tag_template_field_id}/enumValues/{enum_value_display_name}
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 TagTemplateFieldEnumValueName)

public static bool TryParse(string tagTemplateFieldEnumValueName, out TagTemplateFieldEnumValueName result)

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

Parameters
NameDescription
tagTemplateFieldEnumValueNameString

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

resultTagTemplateFieldEnumValueName

When this method returns, the parsed TagTemplateFieldEnumValueName, 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/{tag_template_field_id}/enumValues/{enum_value_display_name}

TryParse(String, Boolean, out TagTemplateFieldEnumValueName)

public static bool TryParse(string tagTemplateFieldEnumValueName, bool allowUnparsed, out TagTemplateFieldEnumValueName result)

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

Parameters
NameDescription
tagTemplateFieldEnumValueNameString

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.

resultTagTemplateFieldEnumValueName

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

Operators

Equality(TagTemplateFieldEnumValueName, TagTemplateFieldEnumValueName)

public static bool operator ==(TagTemplateFieldEnumValueName a, TagTemplateFieldEnumValueName b)
Parameters
NameDescription
aTagTemplateFieldEnumValueName
bTagTemplateFieldEnumValueName
Returns
TypeDescription
Boolean

Inequality(TagTemplateFieldEnumValueName, TagTemplateFieldEnumValueName)

public static bool operator !=(TagTemplateFieldEnumValueName a, TagTemplateFieldEnumValueName b)
Parameters
NameDescription
aTagTemplateFieldEnumValueName
bTagTemplateFieldEnumValueName
Returns
TypeDescription
Boolean