Data Catalog v1 API - Class TagTemplateFieldEnumValueName (2.5.0)

public sealed class TagTemplateFieldEnumValueName : IResourceName, IEquatable<TagTemplateFieldEnumValueName>

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

Resource name for the TagTemplateFieldEnumValue resource.

Inheritance

object > TagTemplateFieldEnumValueName

Implements

IResourceName, IEquatable TagTemplateFieldEnumValueName

Inherited Members

object.GetType()

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
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.
`tagTemplateFieldId`	`string` The `TagTemplateField` ID. Must not be `null` or empty.
`enumValueDisplayNameId`	`string` 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
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`

TagTemplateFieldId

public string TagTemplateFieldId { get; }

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

The TagTemplateFieldEnumValueName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TagTemplateFieldEnumValueNameResourceNameType`

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 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
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.
`tagTemplateFieldId`	`string` The `TagTemplateField` ID. Must not be `null` or empty.
`enumValueDisplayNameId`	`string` The `EnumValueDisplayName` ID. Must not be `null` or empty.

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

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.
`tagTemplateFieldId`	`string` The `TagTemplateField` ID. Must not be `null` or empty.
`enumValueDisplayNameId`	`string` The `EnumValueDisplayName` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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.
`tagTemplateFieldId`	`string` The `TagTemplateField` ID. Must not be `null` or empty.
`enumValueDisplayNameId`	`string` The `EnumValueDisplayName` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

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

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
Name	Description
`tagTemplateFieldEnumValueName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`tagTemplateFieldEnumValueName`	`string` The resource name in string form. Must not be `null`.
`result`	`TagTemplateFieldEnumValueName` When this method returns, the parsed TagTemplateFieldEnumValueName, 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/{tag_template_field_id}/enumValues/{enum_value_display_name}

TryParse(string, bool, 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
Name	Description
`tagTemplateFieldEnumValueName`	`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`	`TagTemplateFieldEnumValueName` When this method returns, the parsed TagTemplateFieldEnumValueName, 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/{tag_template_field_id}/enumValues/{enum_value_display_name}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagTemplateFieldEnumValueName, TagTemplateFieldEnumValueName)

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

Parameters
Name	Description
`a`	`TagTemplateFieldEnumValueName`
`b`	`TagTemplateFieldEnumValueName`

Returns
Type	Description
`bool`

operator !=(TagTemplateFieldEnumValueName, TagTemplateFieldEnumValueName)

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

Parameters
Name	Description
`a`	`TagTemplateFieldEnumValueName`
`b`	`TagTemplateFieldEnumValueName`

Returns
Type	Description
`bool`