Cloud Resource Manager v3 API - Class TagValueName (2.5.0)

public sealed class TagValueName : IResourceName, IEquatable<TagValueName>

Reference documentation and code samples for the Cloud Resource Manager v3 API class TagValueName.

Resource name for the TagValue resource.

Inheritance

object > TagValueName

Implements

IResourceName, IEquatable TagValueName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Constructors

TagValueName(string)

public TagValueName(string tagValueId)

Constructs a new instance of a TagValueName class from the component parts of pattern tagValues/{tag_value}

Parameter
Name	Description
`tagValueId`	`string` The `TagValue` 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`

TagValueId

public string TagValueId { get; }

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

Property Value
Type	Description
`string`

Type

public TagValueName.ResourceNameType Type { get; }

The TagValueName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TagValueNameResourceNameType`

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)

public static string Format(string tagValueId)

Formats the IDs into the string representation of this TagValueName with pattern tagValues/{tag_value}.

Parameter
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TagValueName with pattern `tagValues/{tag_value}`.

FormatTagValue(string)

public static string FormatTagValue(string tagValueId)

Formats the IDs into the string representation of this TagValueName with pattern tagValues/{tag_value}.

Parameter
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TagValueName with pattern `tagValues/{tag_value}`.

FromTagValue(string)

public static TagValueName FromTagValue(string tagValueId)

Creates a TagValueName with the pattern tagValues/{tag_value}.

Parameter
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static TagValueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TagValueName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
`TagValueName`	The parsed TagValueName if successful.

Remarks

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

tagValues/{tag_value}

Parse(string, bool)

public static TagValueName Parse(string tagValueName, bool allowUnparsed)

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

Parameters
Name	Description
`tagValueName`	`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
`TagValueName`	The parsed TagValueName if successful.

Remarks

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

tagValues/{tag_value}

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

public static bool TryParse(string tagValueName, out TagValueName result)

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

Parameters
Name	Description
`tagValueName`	`string` The resource name in string form. Must not be `null`.
`result`	`TagValueName` When this method returns, the parsed TagValueName, 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:

tagValues/{tag_value}

TryParse(string, bool, out TagValueName)

public static bool TryParse(string tagValueName, bool allowUnparsed, out TagValueName result)

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

Parameters
Name	Description
`tagValueName`	`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`	`TagValueName` When this method returns, the parsed TagValueName, 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:

tagValues/{tag_value}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagValueName, TagValueName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TagValueName` The first resource name to compare, or null.
`b`	`TagValueName` 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 !=(TagValueName, TagValueName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TagValueName` The first resource name to compare, or null.
`b`	`TagValueName` 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.