Class LabelName

Resource name for the Label resource.

Inheritance

object

LabelName

Implements

IResourceName

IEquatable<LabelName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class LabelName : IResourceName, IEquatable<LabelName>

Constructors

LabelName(string, string)

Constructs a new instance of a LabelName class from the component parts of pattern networks/{network_code}/labels/{label}

Declaration

public LabelName(string networkCodeId, string labelId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	labelId	The Label 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

LabelId

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

Declaration

public string LabelId { get; }

Property Value

Type	Description
string

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

Type

The LabelName.ResourceNameType of the contained resource name.

Declaration

public LabelName.ResourceNameType Type { get; }

Property Value

Type	Description
LabelName.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 LabelName with pattern networks/{network_code}/labels/{label}.

Declaration

public static string Format(string networkCodeId, string labelId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	labelId	The Label ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this LabelName with pattern networks/{network_code}/labels/{label}.

FormatNetworkCodeLabel(string, string)

Formats the IDs into the string representation of this LabelName with pattern networks/{network_code}/labels/{label}.

Declaration

public static string FormatNetworkCodeLabel(string networkCodeId, string labelId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	labelId	The Label ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this LabelName with pattern networks/{network_code}/labels/{label}.

FromNetworkCodeLabel(string, string)

Creates a LabelName with the pattern networks/{network_code}/labels/{label}.

Declaration

public static LabelName FromNetworkCodeLabel(string networkCodeId, string labelId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	labelId	The Label ID. Must not be null or empty.

Returns

Type	Description
LabelName	A new instance of LabelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a LabelName containing an unparsed resource name.

Declaration

public static LabelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
LabelName	A new instance of LabelName 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 LabelName instance.

Declaration

public static LabelName Parse(string labelName)

Parameters

Type	Name	Description
string	labelName	The resource name in string form. Must not be null.

Returns

Type	Description
LabelName	The parsed LabelName if successful.

Remarks

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

• networks/{network_code}/labels/{label}

Parse(string, bool)

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

Declaration

public static LabelName Parse(string labelName, bool allowUnparsed)

Parameters

Type	Name	Description
string	labelName	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
LabelName	The parsed LabelName if successful.

Remarks

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

• networks/{network_code}/labels/{label}

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

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

Declaration

public static bool TryParse(string labelName, out LabelName result)

Parameters

Type	Name	Description
string	labelName	The resource name in string form. Must not be null.
LabelName	result	When this method returns, the parsed LabelName, 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}/labels/{label}

TryParse(string, bool, out LabelName)

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

Declaration

public static bool TryParse(string labelName, bool allowUnparsed, out LabelName result)

Parameters

Type	Name	Description
string	labelName	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.
LabelName	result	When this method returns, the parsed LabelName, 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}/labels/{label}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LabelName, LabelName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
LabelName	a	The first resource name to compare, or null.
LabelName	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.