Class CmsMetadataValueName

Resource name for the CmsMetadataValue resource.

Inheritance

object

CmsMetadataValueName

Implements

IResourceName

IEquatable<CmsMetadataValueName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CmsMetadataValueName : IResourceName, IEquatable<CmsMetadataValueName>

Constructors

CmsMetadataValueName(string, string)

Constructs a new instance of a CmsMetadataValueName class from the component parts of pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}

Declaration

public CmsMetadataValueName(string networkCodeId, string cmsMetadataValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataValueId	The CmsMetadataValue ID. Must not be null or empty.

Properties

CmsMetadataValueId

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

Declaration

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

Declaration

public CmsMetadataValueName.ResourceNameType Type { get; }

Property Value

Type	Description
CmsMetadataValueName.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 CmsMetadataValueName with pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}.

Declaration

public static string Format(string networkCodeId, string cmsMetadataValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataValueId	The CmsMetadataValue ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CmsMetadataValueName with pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}.

FormatNetworkCodeCmsMetadataValue(string, string)

Formats the IDs into the string representation of this CmsMetadataValueName with pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}.

Declaration

public static string FormatNetworkCodeCmsMetadataValue(string networkCodeId, string cmsMetadataValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataValueId	The CmsMetadataValue ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CmsMetadataValueName with pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}.

FromNetworkCodeCmsMetadataValue(string, string)

Creates a CmsMetadataValueName with the pattern networks/{network_code}/cmsMetadataValues/{cms_metadata_value}.

Declaration

public static CmsMetadataValueName FromNetworkCodeCmsMetadataValue(string networkCodeId, string cmsMetadataValueId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataValueId	The CmsMetadataValue ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CmsMetadataValueName containing an unparsed resource name.

Declaration

public static CmsMetadataValueName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CmsMetadataValueName Parse(string cmsMetadataValueName)

Parameters

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

Returns

Type	Description
CmsMetadataValueName	The parsed CmsMetadataValueName if successful.

Remarks

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

• networks/{network_code}/cmsMetadataValues/{cms_metadata_value}

Parse(string, bool)

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

Declaration

public static CmsMetadataValueName Parse(string cmsMetadataValueName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/cmsMetadataValues/{cms_metadata_value}

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

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

Declaration

public static bool TryParse(string cmsMetadataValueName, out CmsMetadataValueName result)

Parameters

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

TryParse(string, bool, out CmsMetadataValueName)

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

Declaration

public static bool TryParse(string cmsMetadataValueName, bool allowUnparsed, out CmsMetadataValueName result)

Parameters

Type	Name	Description
string	cmsMetadataValueName	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.
CmsMetadataValueName	result	When this method returns, the parsed CmsMetadataValueName, 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}/cmsMetadataValues/{cms_metadata_value}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CmsMetadataValueName, CmsMetadataValueName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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