Class AccountSummaryName

Resource name for the AccountSummary resource.

Inheritance

System.Object

AccountSummaryName

Implements

Google.Api.Gax.IResourceName

System.IEquatable<AccountSummaryName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class AccountSummaryName : IResourceName, IEquatable<AccountSummaryName>

Constructors

AccountSummaryName(String)

Constructs a new instance of a AccountSummaryName class from the component parts of pattern accountSummaries/{account_summary}

Declaration

public AccountSummaryName(string accountSummaryId)

Parameters

Type	Name	Description
System.String	accountSummaryId	The `AccountSummary` ID. Must not be `null` or empty.

Properties

AccountSummaryId

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

Declaration

public string AccountSummaryId { 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 AccountSummaryName.ResourceNameType of the contained resource name.

Declaration

public AccountSummaryName.ResourceNameType Type { get; }

Property Value

Type	Description
AccountSummaryName.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 AccountSummaryName with pattern accountSummaries/{account_summary}.

Declaration

public static string Format(string accountSummaryId)

Parameters

Type	Name	Description
System.String	accountSummaryId	The `AccountSummary` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this AccountSummaryName with pattern `accountSummaries/{account_summary}`.

FormatAccountSummary(String)

Formats the IDs into the string representation of this AccountSummaryName with pattern accountSummaries/{account_summary}.

Declaration

public static string FormatAccountSummary(string accountSummaryId)

Parameters

Type	Name	Description
System.String	accountSummaryId	The `AccountSummary` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this AccountSummaryName with pattern `accountSummaries/{account_summary}`.

FromAccountSummary(String)

Creates a AccountSummaryName with the pattern accountSummaries/{account_summary}.

Declaration

public static AccountSummaryName FromAccountSummary(string accountSummaryId)

Parameters

Type	Name	Description
System.String	accountSummaryId	The `AccountSummary` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AccountSummaryName containing an unparsed resource name.

Declaration

public static AccountSummaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AccountSummaryName Parse(string accountSummaryName)

Parameters

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

Returns

Type	Description
AccountSummaryName	The parsed AccountSummaryName if successful.

Remarks

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

accountSummaries/{account_summary}

Parse(String, Boolean)

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

Declaration

public static AccountSummaryName Parse(string accountSummaryName, bool allowUnparsed)

Parameters

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

Remarks

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

accountSummaries/{account_summary}

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

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

Declaration

public static bool TryParse(string accountSummaryName, out AccountSummaryName result)

Parameters

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

accountSummaries/{account_summary}

TryParse(String, Boolean, out AccountSummaryName)

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

Declaration

public static bool TryParse(string accountSummaryName, bool allowUnparsed, out AccountSummaryName result)

Parameters

Type	Name	Description
System.String	accountSummaryName	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.
AccountSummaryName	result	When this method returns, the parsed AccountSummaryName, 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:

accountSummaries/{account_summary}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AccountSummaryName, AccountSummaryName)

Declaration

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

Parameters

Type	Name	Description
AccountSummaryName	a
AccountSummaryName	b

Returns

Type	Description
System.Boolean

Inequality(AccountSummaryName, AccountSummaryName)

Declaration

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

Parameters

Type	Name	Description
AccountSummaryName	a
AccountSummaryName	b

Returns

Type	Description
System.Boolean