Show / Hide Table of Contents

Class ChildPublisherName

Resource name for the ChildPublisher resource.

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

Constructors

ChildPublisherName(string, string)

Constructs a new instance of a ChildPublisherName class from the component parts of pattern networks/{network_code}/childPublishers/{child_publisher}

Declaration
public ChildPublisherName(string networkCodeId, string childPublisherId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string childPublisherId

The ChildPublisher ID. Must not be null or empty.

Properties

ChildPublisherId

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

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

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 ChildPublisherName.ResourceNameType of the contained resource name.

Declaration
public ChildPublisherName.ResourceNameType Type { get; }
Property Value
Type Description
ChildPublisherName.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 ChildPublisherName with pattern networks/{network_code}/childPublishers/{child_publisher}.

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

The NetworkCode ID. Must not be null or empty.

string childPublisherId

The ChildPublisher ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ChildPublisherName with pattern networks/{network_code}/childPublishers/{child_publisher}.

FormatNetworkCodeChildPublisher(string, string)

Formats the IDs into the string representation of this ChildPublisherName with pattern networks/{network_code}/childPublishers/{child_publisher}.

Declaration
public static string FormatNetworkCodeChildPublisher(string networkCodeId, string childPublisherId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string childPublisherId

The ChildPublisher ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ChildPublisherName with pattern networks/{network_code}/childPublishers/{child_publisher}.

FromNetworkCodeChildPublisher(string, string)

Creates a ChildPublisherName with the pattern networks/{network_code}/childPublishers/{child_publisher}.

Declaration
public static ChildPublisherName FromNetworkCodeChildPublisher(string networkCodeId, string childPublisherId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string childPublisherId

The ChildPublisher ID. Must not be null or empty.

Returns
Type Description
ChildPublisherName

A new instance of ChildPublisherName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ChildPublisherName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
ChildPublisherName

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

Declaration
public static ChildPublisherName Parse(string childPublisherName)
Parameters
Type Name Description
string childPublisherName

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

Returns
Type Description
ChildPublisherName

The parsed ChildPublisherName if successful.

Remarks

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

  • networks/{network_code}/childPublishers/{child_publisher}

Parse(string, bool)

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

Declaration
public static ChildPublisherName Parse(string childPublisherName, bool allowUnparsed)
Parameters
Type Name Description
string childPublisherName

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
ChildPublisherName

The parsed ChildPublisherName if successful.

Remarks

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

  • networks/{network_code}/childPublishers/{child_publisher}

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

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

Declaration
public static bool TryParse(string childPublisherName, out ChildPublisherName result)
Parameters
Type Name Description
string childPublisherName

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

ChildPublisherName result

When this method returns, the parsed ChildPublisherName, 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}/childPublishers/{child_publisher}

TryParse(string, bool, out ChildPublisherName)

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

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

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.

ChildPublisherName result

When this method returns, the parsed ChildPublisherName, 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}/childPublishers/{child_publisher}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChildPublisherName, ChildPublisherName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

ChildPublisherName 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