Show / Hide Table of Contents

Class YieldGroupName

Resource name for the YieldGroup resource.

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

Constructors

YieldGroupName(string, string)

Constructs a new instance of a YieldGroupName class from the component parts of pattern networks/{network_code}/yieldGroups/{yield_group}

Declaration
public YieldGroupName(string networkCodeId, string yieldGroupId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string yieldGroupId

The YieldGroup 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

Type

The YieldGroupName.ResourceNameType of the contained resource name.

Declaration
public YieldGroupName.ResourceNameType Type { get; }
Property Value
Type Description
YieldGroupName.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

YieldGroupId

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

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

Methods

Format(string, string)

Formats the IDs into the string representation of this YieldGroupName with pattern networks/{network_code}/yieldGroups/{yield_group}.

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

The NetworkCode ID. Must not be null or empty.

string yieldGroupId

The YieldGroup ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this YieldGroupName with pattern networks/{network_code}/yieldGroups/{yield_group}.

FormatNetworkCodeYieldGroup(string, string)

Formats the IDs into the string representation of this YieldGroupName with pattern networks/{network_code}/yieldGroups/{yield_group}.

Declaration
public static string FormatNetworkCodeYieldGroup(string networkCodeId, string yieldGroupId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string yieldGroupId

The YieldGroup ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this YieldGroupName with pattern networks/{network_code}/yieldGroups/{yield_group}.

FromNetworkCodeYieldGroup(string, string)

Creates a YieldGroupName with the pattern networks/{network_code}/yieldGroups/{yield_group} .

Declaration
public static YieldGroupName FromNetworkCodeYieldGroup(string networkCodeId, string yieldGroupId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string yieldGroupId

The YieldGroup ID. Must not be null or empty.

Returns
Type Description
YieldGroupName

A new instance of YieldGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a YieldGroupName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
YieldGroupName

A new instance of YieldGroupName 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 YieldGroupName instance.

Declaration
public static YieldGroupName Parse(string yieldGroupName)
Parameters
Type Name Description
string yieldGroupName

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

Returns
Type Description
YieldGroupName

The parsed YieldGroupName if successful.

Remarks

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

  • networks/{network_code}/yieldGroups/{yield_group}

Parse(string, bool)

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

Declaration
public static YieldGroupName Parse(string yieldGroupName, bool allowUnparsed)
Parameters
Type Name Description
string yieldGroupName

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
YieldGroupName

The parsed YieldGroupName if successful.

Remarks

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

  • networks/{network_code}/yieldGroups/{yield_group}

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

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

Declaration
public static bool TryParse(string yieldGroupName, out YieldGroupName result)
Parameters
Type Name Description
string yieldGroupName

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

YieldGroupName result

When this method returns, the parsed YieldGroupName, 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}/yieldGroups/{yield_group}

TryParse(string, bool, out YieldGroupName)

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

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

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.

YieldGroupName result

When this method returns, the parsed YieldGroupName, 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}/yieldGroups/{yield_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(YieldGroupName, YieldGroupName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

YieldGroupName 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