Show / Hide Table of Contents

Class EntitySignalsMappingName

Resource name for the EntitySignalsMapping resource.

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

Constructors

EntitySignalsMappingName(string, string)

Constructs a new instance of a EntitySignalsMappingName class from the component parts of pattern networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}

Declaration
public EntitySignalsMappingName(string networkCodeId, string entitySignalsMappingId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string entitySignalsMappingId

The EntitySignalsMapping ID. Must not be null or empty.

Properties

EntitySignalsMappingId

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

Declaration
public string EntitySignalsMappingId { 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 EntitySignalsMappingName.ResourceNameType of the contained resource name.

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

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

The NetworkCode ID. Must not be null or empty.

string entitySignalsMappingId

The EntitySignalsMapping ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EntitySignalsMappingName with pattern networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}.

FormatNetworkCodeEntitySignalsMapping(string, string)

Formats the IDs into the string representation of this EntitySignalsMappingName with pattern networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}.

Declaration
public static string FormatNetworkCodeEntitySignalsMapping(string networkCodeId, string entitySignalsMappingId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string entitySignalsMappingId

The EntitySignalsMapping ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this EntitySignalsMappingName with pattern networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}.

FromNetworkCodeEntitySignalsMapping(string, string)

Creates a EntitySignalsMappingName with the pattern networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}.

Declaration
public static EntitySignalsMappingName FromNetworkCodeEntitySignalsMapping(string networkCodeId, string entitySignalsMappingId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string entitySignalsMappingId

The EntitySignalsMapping ID. Must not be null or empty.

Returns
Type Description
EntitySignalsMappingName

A new instance of EntitySignalsMappingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a EntitySignalsMappingName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
EntitySignalsMappingName

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

Declaration
public static EntitySignalsMappingName Parse(string entitySignalsMappingName)
Parameters
Type Name Description
string entitySignalsMappingName

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

Returns
Type Description
EntitySignalsMappingName

The parsed EntitySignalsMappingName if successful.

Remarks

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

  • networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}

Parse(string, bool)

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

Declaration
public static EntitySignalsMappingName Parse(string entitySignalsMappingName, bool allowUnparsed)
Parameters
Type Name Description
string entitySignalsMappingName

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
EntitySignalsMappingName

The parsed EntitySignalsMappingName if successful.

Remarks

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

  • networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}
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 EntitySignalsMappingName)

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

Declaration
public static bool TryParse(string entitySignalsMappingName, out EntitySignalsMappingName result)
Parameters
Type Name Description
string entitySignalsMappingName

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

EntitySignalsMappingName result

When this method returns, the parsed EntitySignalsMappingName, 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}/entitySignalsMappings/{entity_signals_mapping}

TryParse(string, bool, out EntitySignalsMappingName)

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

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

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.

EntitySignalsMappingName result

When this method returns, the parsed EntitySignalsMappingName, 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}/entitySignalsMappings/{entity_signals_mapping}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EntitySignalsMappingName, EntitySignalsMappingName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

EntitySignalsMappingName 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