Cloud Resource Manager v3 API - Class TagHoldName (2.5.0)

public sealed class TagHoldName : IResourceName, IEquatable<TagHoldName>

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

Resource name for the TagHold resource.

Inheritance

object > TagHoldName

Implements

IResourceName, IEquatable TagHoldName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Constructors

TagHoldName(string, string)

public TagHoldName(string tagValueId, string tagHoldId)

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

Parameters
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.
`tagHoldId`	`string` The `TagHold` 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`

TagHoldId

public string TagHoldId { get; }

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

Property Value
Type	Description
`string`

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

The TagHoldName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TagHoldNameResourceNameType`

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)

public static string Format(string tagValueId, string tagHoldId)

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

Parameters
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.
`tagHoldId`	`string` The `TagHold` ID. Must not be `null` or empty.

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

FormatTagValueTagHold(string, string)

public static string FormatTagValueTagHold(string tagValueId, string tagHoldId)

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

Parameters
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.
`tagHoldId`	`string` The `TagHold` ID. Must not be `null` or empty.

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

FromTagValueTagHold(string, string)

public static TagHoldName FromTagValueTagHold(string tagValueId, string tagHoldId)

Creates a TagHoldName with the pattern tagValues/{tag_value}/tagHolds/{tag_hold}.

Parameters
Name	Description
`tagValueId`	`string` The `TagValue` ID. Must not be `null` or empty.
`tagHoldId`	`string` The `TagHold` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static TagHoldName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TagHoldName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

tagValues/{tag_value}/tagHolds/{tag_hold}

Parse(string, bool)

public static TagHoldName Parse(string tagHoldName, bool allowUnparsed)

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

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

Remarks

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

tagValues/{tag_value}/tagHolds/{tag_hold}

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

public static bool TryParse(string tagHoldName, out TagHoldName result)

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

Parameters
Name	Description
`tagHoldName`	`string` The resource name in string form. Must not be `null`.
`result`	`TagHoldName` When this method returns, the parsed TagHoldName, 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}/tagHolds/{tag_hold}

TryParse(string, bool, out TagHoldName)

public static bool TryParse(string tagHoldName, bool allowUnparsed, out TagHoldName result)

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

Parameters
Name	Description
`tagHoldName`	`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`	`TagHoldName` When this method returns, the parsed TagHoldName, 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}/tagHolds/{tag_hold}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TagHoldName, TagHoldName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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