Class CmsMetadataKeyName

Resource name for the CmsMetadataKey resource.

Inheritance

object

CmsMetadataKeyName

Implements

IResourceName

IEquatable<CmsMetadataKeyName>

Inherited Members

object.GetType()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class CmsMetadataKeyName : IResourceName, IEquatable<CmsMetadataKeyName>

Constructors

CmsMetadataKeyName(string, string)

Constructs a new instance of a CmsMetadataKeyName class from the component parts of pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}

Declaration

public CmsMetadataKeyName(string networkCodeId, string cmsMetadataKeyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataKeyId	The CmsMetadataKey ID. Must not be null or empty.

Properties

CmsMetadataKeyId

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

Declaration

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

Declaration

public CmsMetadataKeyName.ResourceNameType Type { get; }

Property Value

Type	Description
CmsMetadataKeyName.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 CmsMetadataKeyName with pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}.

Declaration

public static string Format(string networkCodeId, string cmsMetadataKeyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataKeyId	The CmsMetadataKey ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CmsMetadataKeyName with pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}.

FormatNetworkCodeCmsMetadataKey(string, string)

Formats the IDs into the string representation of this CmsMetadataKeyName with pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}.

Declaration

public static string FormatNetworkCodeCmsMetadataKey(string networkCodeId, string cmsMetadataKeyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataKeyId	The CmsMetadataKey ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this CmsMetadataKeyName with pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}.

FromNetworkCodeCmsMetadataKey(string, string)

Creates a CmsMetadataKeyName with the pattern networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}.

Declaration

public static CmsMetadataKeyName FromNetworkCodeCmsMetadataKey(string networkCodeId, string cmsMetadataKeyId)

Parameters

Type	Name	Description
string	networkCodeId	The NetworkCode ID. Must not be null or empty.
string	cmsMetadataKeyId	The CmsMetadataKey ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CmsMetadataKeyName containing an unparsed resource name.

Declaration

public static CmsMetadataKeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static CmsMetadataKeyName Parse(string cmsMetadataKeyName)

Parameters

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

Returns

Type	Description
CmsMetadataKeyName	The parsed CmsMetadataKeyName if successful.

Remarks

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

• networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}

Parse(string, bool)

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

Declaration

public static CmsMetadataKeyName Parse(string cmsMetadataKeyName, bool allowUnparsed)

Parameters

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

Remarks

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

• networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}

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

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

Declaration

public static bool TryParse(string cmsMetadataKeyName, out CmsMetadataKeyName result)

Parameters

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

TryParse(string, bool, out CmsMetadataKeyName)

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

Declaration

public static bool TryParse(string cmsMetadataKeyName, bool allowUnparsed, out CmsMetadataKeyName result)

Parameters

Type	Name	Description
string	cmsMetadataKeyName	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.
CmsMetadataKeyName	result	When this method returns, the parsed CmsMetadataKeyName, 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}/cmsMetadataKeys/{cms_metadata_key}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CmsMetadataKeyName, CmsMetadataKeyName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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