Show / Hide Table of Contents

Class TaxonomyCategoryName

Resource name for the TaxonomyCategory resource.

Inheritance
object
TaxonomyCategoryName
Implements
IResourceName
IEquatable<TaxonomyCategoryName>
Inherited Members
object.GetType()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class TaxonomyCategoryName : IResourceName, IEquatable<TaxonomyCategoryName>

Constructors

TaxonomyCategoryName(string, string)

Constructs a new instance of a TaxonomyCategoryName class from the component parts of pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}

Declaration
public TaxonomyCategoryName(string networkCodeId, string taxonomyCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string taxonomyCategoryId

The TaxonomyCategory ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration
public bool IsKnownPattern { get; }
Property Value
Type Description
bool
Implements
IResourceName.IsKnownPattern

NetworkCodeId

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

Declaration
public string NetworkCodeId { get; }
Property Value
Type Description
string

TaxonomyCategoryId

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

Declaration
public string TaxonomyCategoryId { get; }
Property Value
Type Description
string

Type

The TaxonomyCategoryName.ResourceNameType of the contained resource name.

Declaration
public TaxonomyCategoryName.ResourceNameType Type { get; }
Property Value
Type Description
TaxonomyCategoryName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration
public UnparsedResourceName UnparsedResource { get; }
Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this TaxonomyCategoryName with pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}.

Declaration
public static string Format(string networkCodeId, string taxonomyCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string taxonomyCategoryId

The TaxonomyCategory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TaxonomyCategoryName with pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}.

FormatNetworkCodeTaxonomyCategory(string, string)

Formats the IDs into the string representation of this TaxonomyCategoryName with pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}.

Declaration
public static string FormatNetworkCodeTaxonomyCategory(string networkCodeId, string taxonomyCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string taxonomyCategoryId

The TaxonomyCategory ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TaxonomyCategoryName with pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}.

FromNetworkCodeTaxonomyCategory(string, string)

Creates a TaxonomyCategoryName with the pattern networks/{network_code}/taxonomyCategories/{taxonomy_category}.

Declaration
public static TaxonomyCategoryName FromNetworkCodeTaxonomyCategory(string networkCodeId, string taxonomyCategoryId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string taxonomyCategoryId

The TaxonomyCategory ID. Must not be null or empty.

Returns
Type Description
TaxonomyCategoryName

A new instance of TaxonomyCategoryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a TaxonomyCategoryName containing an unparsed resource name.

Declaration
public static TaxonomyCategoryName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TaxonomyCategoryName

A new instance of TaxonomyCategoryName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

Parse(string)

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

Declaration
public static TaxonomyCategoryName Parse(string taxonomyCategoryName)
Parameters
Type Name Description
string taxonomyCategoryName

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

Returns
Type Description
TaxonomyCategoryName

The parsed TaxonomyCategoryName if successful.

Remarks

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

  • networks/{network_code}/taxonomyCategories/{taxonomy_category}

Parse(string, bool)

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

Declaration
public static TaxonomyCategoryName Parse(string taxonomyCategoryName, bool allowUnparsed)
Parameters
Type Name Description
string taxonomyCategoryName

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

bool allowUnparsed

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
TaxonomyCategoryName

The parsed TaxonomyCategoryName if successful.

Remarks

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

  • networks/{network_code}/taxonomyCategories/{taxonomy_category}
Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration
public override string ToString()
Returns
Type Description
string

The string representation of the resource name.

Overrides
object.ToString()
Implements
IResourceName.ToString()

TryParse(string, out TaxonomyCategoryName)

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

Declaration
public static bool TryParse(string taxonomyCategoryName, out TaxonomyCategoryName result)
Parameters
Type Name Description
string taxonomyCategoryName

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

TaxonomyCategoryName result

When this method returns, the parsed TaxonomyCategoryName, 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:

  • networks/{network_code}/taxonomyCategories/{taxonomy_category}

TryParse(string, bool, out TaxonomyCategoryName)

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

Declaration
public static bool TryParse(string taxonomyCategoryName, bool allowUnparsed, out TaxonomyCategoryName result)
Parameters
Type Name Description
string taxonomyCategoryName

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

bool allowUnparsed

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.

TaxonomyCategoryName result

When this method returns, the parsed TaxonomyCategoryName, 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:

  • networks/{network_code}/taxonomyCategories/{taxonomy_category}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaxonomyCategoryName, TaxonomyCategoryName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(TaxonomyCategoryName a, TaxonomyCategoryName b)
Parameters
Type Name Description
TaxonomyCategoryName a

The first resource name to compare, or null.

TaxonomyCategoryName b

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 !=(TaxonomyCategoryName, TaxonomyCategoryName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(TaxonomyCategoryName a, TaxonomyCategoryName b)
Parameters
Type Name Description
TaxonomyCategoryName a

The first resource name to compare, or null.

TaxonomyCategoryName b

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.

In this article
Back to top Generated by DocFX