Show / Hide Table of Contents

Class ApplicationName

Resource name for the Application resource.

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

Constructors

ApplicationName(string, string)

Constructs a new instance of a ApplicationName class from the component parts of pattern networks/{network_code}/applications/{application}

Declaration
public ApplicationName(string networkCodeId, string applicationId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string applicationId

The Application ID. Must not be null or empty.

Properties

ApplicationId

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

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

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

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

The NetworkCode ID. Must not be null or empty.

string applicationId

The Application ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ApplicationName with pattern networks/{network_code}/applications/{application}.

FormatNetworkCodeApplication(string, string)

Formats the IDs into the string representation of this ApplicationName with pattern networks/{network_code}/applications/{application}.

Declaration
public static string FormatNetworkCodeApplication(string networkCodeId, string applicationId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string applicationId

The Application ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ApplicationName with pattern networks/{network_code}/applications/{application}.

FromNetworkCodeApplication(string, string)

Creates a ApplicationName with the pattern networks/{network_code}/applications/{application}.

Declaration
public static ApplicationName FromNetworkCodeApplication(string networkCodeId, string applicationId)
Parameters
Type Name Description
string networkCodeId

The NetworkCode ID. Must not be null or empty.

string applicationId

The Application ID. Must not be null or empty.

Returns
Type Description
ApplicationName

A new instance of ApplicationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a ApplicationName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
ApplicationName

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

Declaration
public static ApplicationName Parse(string applicationName)
Parameters
Type Name Description
string applicationName

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

Returns
Type Description
ApplicationName

The parsed ApplicationName if successful.

Remarks

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

  • networks/{network_code}/applications/{application}

Parse(string, bool)

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

Declaration
public static ApplicationName Parse(string applicationName, bool allowUnparsed)
Parameters
Type Name Description
string applicationName

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
ApplicationName

The parsed ApplicationName if successful.

Remarks

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

  • networks/{network_code}/applications/{application}
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 ApplicationName)

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

Declaration
public static bool TryParse(string applicationName, out ApplicationName result)
Parameters
Type Name Description
string applicationName

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

ApplicationName result

When this method returns, the parsed ApplicationName, 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}/applications/{application}

TryParse(string, bool, out ApplicationName)

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

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

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.

ApplicationName result

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

Operators

operator ==(ApplicationName, ApplicationName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

ApplicationName 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