Class AccountName

Resource name for the Account resource.

Inheritance

System.Object

AccountName

Implements

Google.Api.Gax.IResourceName

System.IEquatable<AccountName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class AccountName : IResourceName, IEquatable<AccountName>

Constructors

AccountName(String)

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

Declaration

public AccountName(string accountId)

Parameters

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

Properties

AccountId

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

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

Type

The AccountName.ResourceNameType of the contained resource name.

Declaration

public AccountName.ResourceNameType Type { get; }

Property Value

Type	Description
AccountName.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

Methods

Format(String)

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

Declaration

public static string Format(string accountId)

Parameters

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

Returns

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

FormatAccount(String)

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

Declaration

public static string FormatAccount(string accountId)

Parameters

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

Returns

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

FromAccount(String)

Creates a AccountName with the pattern accounts/{account}.

Declaration

public static AccountName FromAccount(string accountId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AccountName containing an unparsed resource name.

Declaration

public static AccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AccountName Parse(string accountName)

Parameters

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

Returns

Type	Description
AccountName	The parsed AccountName if successful.

Remarks

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

accounts/{account}

Parse(String, Boolean)

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

Declaration

public static AccountName Parse(string accountName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	accountName	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
AccountName	The parsed AccountName if successful.

Remarks

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

accounts/{account}

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

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

Declaration

public static bool TryParse(string accountName, out AccountName result)

Parameters

Type	Name	Description
System.String	accountName	The resource name in string form. Must not be `null`.
AccountName	result	When this method returns, the parsed AccountName, 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}

TryParse(String, Boolean, out AccountName)

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

Declaration

public static bool TryParse(string accountName, bool allowUnparsed, out AccountName result)

Parameters

Type	Name	Description
System.String	accountName	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.
AccountName	result	When this method returns, the parsed AccountName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AccountName, AccountName)

Declaration

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

Parameters

Type	Name	Description
AccountName	a
AccountName	b

Returns

Type	Description
System.Boolean

Inequality(AccountName, AccountName)

Declaration

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

Parameters

Type	Name	Description
AccountName	a
AccountName	b

Returns

Type	Description
System.Boolean