Class AccountName

Resource name for the Account resource.

Inheritance

object

AccountName

Implements

IResourceName

IEquatable<AccountName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.DataSources.V1Beta

Assembly: Google.Shopping.Merchant.DataSources.V1Beta.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
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
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

Type

The AccountName.ResourceNameType of the contained resource name.

Declaration

public AccountName.ResourceNameType Type { get; }

Property Value

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

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
string	accountId	The `Account` ID. Must not be `null` or empty.

Returns

Type	Description
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
string	accountId	The `Account` ID. Must not be `null` or empty.

Returns

Type	Description
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
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
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
int

Overrides

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
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, bool)

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
string	accountName	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
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
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

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
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
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:

accounts/{account}

TryParse(string, bool, 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
string	accountName	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.
AccountName	result	When this method returns, the parsed AccountName, 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:

accounts/{account}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccountName, AccountName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
AccountName	a	The first resource name to compare, or null.
AccountName	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 !=(AccountName, AccountName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
AccountName	a	The first resource name to compare, or null.
AccountName	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.