Class UserLinkName

Resource name for the UserLink resource.

Inheritance

System.Object

UserLinkName

Implements

Google.Api.Gax.IResourceName

System.IEquatable<UserLinkName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class UserLinkName : IResourceName, IEquatable<UserLinkName>

Constructors

UserLinkName(String, String)

Constructs a new instance of a UserLinkName class from the component parts of pattern accounts/{account}/userLinks/{user_link}

Declaration

public UserLinkName(string accountId, string userLinkId)

Parameters

Type	Name	Description
System.String	accountId	The `Account` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Properties

AccountId

The Account ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string AccountId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

Google.Api.Gax.IResourceName.IsKnownPattern

PropertyId

The Property ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string PropertyId { get; }

Property Value

Type	Description
System.String

Type

The UserLinkName.ResourceNameType of the contained resource name.

Declaration

public UserLinkName.ResourceNameType Type { get; }

Property Value

Type	Description
UserLinkName.ResourceNameType

UnparsedResource

The contained Google.Api.Gax.UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
Google.Api.Gax.UnparsedResourceName

UserLinkId

The UserLink ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string UserLinkId { get; }

Property Value

Type	Description
System.String

Methods

Format(String, String)

Formats the IDs into the string representation of this UserLinkName with pattern accounts/{account}/userLinks/{user_link}.

Declaration

public static string Format(string accountId, string userLinkId)

Parameters

Type	Name	Description
System.String	accountId	The `Account` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this UserLinkName with pattern `accounts/{account}/userLinks/{user_link}`.

FormatAccountUserLink(String, String)

Formats the IDs into the string representation of this UserLinkName with pattern accounts/{account}/userLinks/{user_link}.

Declaration

public static string FormatAccountUserLink(string accountId, string userLinkId)

Parameters

Type	Name	Description
System.String	accountId	The `Account` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this UserLinkName with pattern `accounts/{account}/userLinks/{user_link}`.

FormatPropertyUserLink(String, String)

Formats the IDs into the string representation of this UserLinkName with pattern properties/{property}/userLinks/{user_link}.

Declaration

public static string FormatPropertyUserLink(string propertyId, string userLinkId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this UserLinkName with pattern `properties/{property}/userLinks/{user_link}`.

FromAccountUserLink(String, String)

Creates a UserLinkName with the pattern accounts/{account}/userLinks/{user_link}.

Declaration

public static UserLinkName FromAccountUserLink(string accountId, string userLinkId)

Parameters

Type	Name	Description
System.String	accountId	The `Account` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Returns

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

FromPropertyUserLink(String, String)

Creates a UserLinkName with the pattern properties/{property}/userLinks/{user_link}.

Declaration

public static UserLinkName FromPropertyUserLink(string propertyId, string userLinkId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	userLinkId	The `UserLink` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a UserLinkName containing an unparsed resource name.

Declaration

public static UserLinkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
Google.Api.Gax.UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be `null`.

Returns

Type	Description
UserLinkName	A new instance of UserLinkName containing the provided `unparsedResourceName` .

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

Parses the given resource name string into a new UserLinkName instance.

Declaration

public static UserLinkName Parse(string userLinkName)

Parameters

Type	Name	Description
System.String	userLinkName	The resource name in string form. Must not be `null`.

Returns

Type	Description
UserLinkName	The parsed UserLinkName if successful.

Remarks

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

accounts/{account}/userLinks/{user_link}
properties/{property}/userLinks/{user_link}

Parse(String, Boolean)

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

Declaration

public static UserLinkName Parse(string userLinkName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	userLinkName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
UserLinkName	The parsed UserLinkName if successful.

Remarks

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

accounts/{account}/userLinks/{user_link}
properties/{property}/userLinks/{user_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
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

Google.Api.Gax.IResourceName.ToString()

TryParse(String, out UserLinkName)

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

Declaration

public static bool TryParse(string userLinkName, out UserLinkName result)

Parameters

Type	Name	Description
System.String	userLinkName	The resource name in string form. Must not be `null`.
UserLinkName	result	When this method returns, the parsed UserLinkName, or `null` if parsing failed.

Returns

Type	Description
System.Boolean	`true` if the name was parsed successfully; `false` otherwise.

Remarks

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

accounts/{account}/userLinks/{user_link}
properties/{property}/userLinks/{user_link}

TryParse(String, Boolean, out UserLinkName)

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

Declaration

public static bool TryParse(string userLinkName, bool allowUnparsed, out UserLinkName result)

Parameters

Type	Name	Description
System.String	userLinkName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
UserLinkName	result	When this method returns, the parsed UserLinkName, or `null` if parsing failed.

Returns

Type	Description
System.Boolean	`true` if the name was parsed successfully; `false` otherwise.

Remarks

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

accounts/{account}/userLinks/{user_link}
properties/{property}/userLinks/{user_link}

Or may be in any format if allowUnparsed is true.

Operators

Equality(UserLinkName, UserLinkName)

Declaration

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

Parameters

Type	Name	Description
UserLinkName	a
UserLinkName	b

Returns

Type	Description
System.Boolean

Inequality(UserLinkName, UserLinkName)

Declaration

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

Parameters

Type	Name	Description
UserLinkName	a
UserLinkName	b

Returns

Type	Description
System.Boolean