Class CompanyName

Resource name for the Company resource.

Inheritance

object

CompanyName

Implements

IResourceName

IEquatable<CompanyName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CompanyName : IResourceName, IEquatable<CompanyName>

Constructors

CompanyName(string, string)

Constructs a new instance of a CompanyName class from the component parts of pattern networks/{network_code}/companies/{company}

Declaration

public CompanyName(string networkCodeId, string companyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	companyId	The Company ID. Must not be null or empty.

Properties

CompanyId

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

Declaration

public string CompanyId { 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 CompanyName.ResourceNameType of the contained resource name.

Declaration

public CompanyName.ResourceNameType Type { get; }

Property Value

Type	Description
CompanyName.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 CompanyName with pattern networks/{network_code}/companies/{company}.

Declaration

public static string Format(string networkCodeId, string companyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	companyId	The Company ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CompanyName with pattern networks/{network_code}/companies/{company}.

FormatNetworkCodeCompany(string, string)

Formats the IDs into the string representation of this CompanyName with pattern networks/{network_code}/companies/{company}.

Declaration

public static string FormatNetworkCodeCompany(string networkCodeId, string companyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	companyId	The Company ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CompanyName with pattern networks/{network_code}/companies/{company}.

FromNetworkCodeCompany(string, string)

Creates a CompanyName with the pattern networks/{network_code}/companies/{company}.

Declaration

public static CompanyName FromNetworkCodeCompany(string networkCodeId, string companyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	companyId	The Company ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CompanyName containing an unparsed resource name.

Declaration

public static CompanyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CompanyName Parse(string companyName)

Parameters

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

Returns

Type	Description
CompanyName	The parsed CompanyName if successful.

Remarks

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

• networks/{network_code}/companies/{company}

Parse(string, bool)

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

Declaration

public static CompanyName Parse(string companyName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/companies/{company}

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

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

Declaration

public static bool TryParse(string companyName, out CompanyName result)

Parameters

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

TryParse(string, bool, out CompanyName)

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

Declaration

public static bool TryParse(string companyName, bool allowUnparsed, out CompanyName result)

Parameters

Type	Name	Description
string	companyName	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.
CompanyName	result	When this method returns, the parsed CompanyName, 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}/companies/{company}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CompanyName, CompanyName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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