Show / Hide Table of Contents

Class AnalyticsAccountLinkName

Resource name for the AnalyticsAccountLink resource.

Inheritance
object
AnalyticsAccountLinkName
Implements
IResourceName
IEquatable<AnalyticsAccountLinkName>
Inherited Members
object.GetType()
Namespace: Google.Ads.MarketingPlatform.Admin.V1Alpha
Assembly: Google.Ads.MarketingPlatform.Admin.V1Alpha.dll
Syntax
public sealed class AnalyticsAccountLinkName : IResourceName, IEquatable<AnalyticsAccountLinkName>

Constructors

AnalyticsAccountLinkName(string, string)

Constructs a new instance of a AnalyticsAccountLinkName class from the component parts of pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}

Declaration
public AnalyticsAccountLinkName(string organizationId, string analyticsAccountLinkId)
Parameters
Type Name Description
string organizationId

The Organization ID. Must not be null or empty.

string analyticsAccountLinkId

The AnalyticsAccountLink ID. Must not be null or empty.

Properties

AnalyticsAccountLinkId

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

Declaration
public string AnalyticsAccountLinkId { 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

OrganizationId

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

Declaration
public string OrganizationId { get; }
Property Value
Type Description
string

Type

The AnalyticsAccountLinkName.ResourceNameType of the contained resource name.

Declaration
public AnalyticsAccountLinkName.ResourceNameType Type { get; }
Property Value
Type Description
AnalyticsAccountLinkName.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 AnalyticsAccountLinkName with pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.

Declaration
public static string Format(string organizationId, string analyticsAccountLinkId)
Parameters
Type Name Description
string organizationId

The Organization ID. Must not be null or empty.

string analyticsAccountLinkId

The AnalyticsAccountLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AnalyticsAccountLinkName with pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.

FormatOrganizationAnalyticsAccountLink(string, string)

Formats the IDs into the string representation of this AnalyticsAccountLinkName with pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.

Declaration
public static string FormatOrganizationAnalyticsAccountLink(string organizationId, string analyticsAccountLinkId)
Parameters
Type Name Description
string organizationId

The Organization ID. Must not be null or empty.

string analyticsAccountLinkId

The AnalyticsAccountLink ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AnalyticsAccountLinkName with pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.

FromOrganizationAnalyticsAccountLink(string, string)

Creates a AnalyticsAccountLinkName with the pattern organizations/{organization}/analyticsAccountLinks/{analytics_account_link}.

Declaration
public static AnalyticsAccountLinkName FromOrganizationAnalyticsAccountLink(string organizationId, string analyticsAccountLinkId)
Parameters
Type Name Description
string organizationId

The Organization ID. Must not be null or empty.

string analyticsAccountLinkId

The AnalyticsAccountLink ID. Must not be null or empty.

Returns
Type Description
AnalyticsAccountLinkName

A new instance of AnalyticsAccountLinkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a AnalyticsAccountLinkName containing an unparsed resource name.

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

The unparsed resource name. Must not be null.

Returns
Type Description
AnalyticsAccountLinkName

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

Declaration
public static AnalyticsAccountLinkName Parse(string analyticsAccountLinkName)
Parameters
Type Name Description
string analyticsAccountLinkName

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

Returns
Type Description
AnalyticsAccountLinkName

The parsed AnalyticsAccountLinkName if successful.

Remarks

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

  • organizations/{organization}/analyticsAccountLinks/{analytics_account_link}

Parse(string, bool)

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

Declaration
public static AnalyticsAccountLinkName Parse(string analyticsAccountLinkName, bool allowUnparsed)
Parameters
Type Name Description
string analyticsAccountLinkName

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
AnalyticsAccountLinkName

The parsed AnalyticsAccountLinkName if successful.

Remarks

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

  • organizations/{organization}/analyticsAccountLinks/{analytics_account_link}
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 AnalyticsAccountLinkName)

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

Declaration
public static bool TryParse(string analyticsAccountLinkName, out AnalyticsAccountLinkName result)
Parameters
Type Name Description
string analyticsAccountLinkName

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

AnalyticsAccountLinkName result

When this method returns, the parsed AnalyticsAccountLinkName, 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:

  • organizations/{organization}/analyticsAccountLinks/{analytics_account_link}

TryParse(string, bool, out AnalyticsAccountLinkName)

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

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

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.

AnalyticsAccountLinkName result

When this method returns, the parsed AnalyticsAccountLinkName, 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:

  • organizations/{organization}/analyticsAccountLinks/{analytics_account_link}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnalyticsAccountLinkName, AnalyticsAccountLinkName)

Determines whether two specified resource names have the same value.

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

The first resource name to compare, or null.

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

Determines whether two specified resource names have different values.

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

The first resource name to compare, or null.

AnalyticsAccountLinkName 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