Class GbpAccountName

Resource name for the GbpAccount resource.

Inheritance

object

GbpAccountName

Implements

IResourceName

IEquatable<GbpAccountName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

Assembly: Google.Shopping.Merchant.Accounts.V1.dll

Syntax

public sealed class GbpAccountName : IResourceName, IEquatable<GbpAccountName>

Constructors

GbpAccountName(string, string)

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

Declaration

public GbpAccountName(string accountId, string gbpAccountId)

Parameters

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

GbpAccountId

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

Declaration

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

Declaration

public GbpAccountName.ResourceNameType Type { get; }

Property Value

Type	Description
GbpAccountName.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 GbpAccountName with pattern accounts/{account}/gbpAccounts/{gbp_account}.

Declaration

public static string Format(string accountId, string gbpAccountId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	gbpAccountId	The GbpAccount ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this GbpAccountName with pattern accounts/{account}/gbpAccounts/{gbp_account}.

FormatAccountGbpAccount(string, string)

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

Declaration

public static string FormatAccountGbpAccount(string accountId, string gbpAccountId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	gbpAccountId	The GbpAccount ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this GbpAccountName with pattern accounts/{account}/gbpAccounts/{gbp_account}.

FromAccountGbpAccount(string, string)

Creates a GbpAccountName with the pattern accounts/{account}/gbpAccounts/{gbp_account}.

Declaration

public static GbpAccountName FromAccountGbpAccount(string accountId, string gbpAccountId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	gbpAccountId	The GbpAccount ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a GbpAccountName containing an unparsed resource name.

Declaration

public static GbpAccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

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

Declaration

public static GbpAccountName Parse(string gbpAccountName)

Parameters

Type	Name	Description
string	gbpAccountName	The resource name in string form. Must not be null.

Returns

Type	Description
GbpAccountName	The parsed GbpAccountName if successful.

Remarks

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

• accounts/{account}/gbpAccounts/{gbp_account}

Parse(string, bool)

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

Declaration

public static GbpAccountName Parse(string gbpAccountName, bool allowUnparsed)

Parameters

Type	Name	Description
string	gbpAccountName	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
GbpAccountName	The parsed GbpAccountName if successful.

Remarks

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

• accounts/{account}/gbpAccounts/{gbp_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 GbpAccountName)

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

Declaration

public static bool TryParse(string gbpAccountName, out GbpAccountName result)

Parameters

Type	Name	Description
string	gbpAccountName	The resource name in string form. Must not be null.
GbpAccountName	result	When this method returns, the parsed GbpAccountName, 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}/gbpAccounts/{gbp_account}

TryParse(string, bool, out GbpAccountName)

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

Declaration

public static bool TryParse(string gbpAccountName, bool allowUnparsed, out GbpAccountName result)

Parameters

Type	Name	Description
string	gbpAccountName	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.
GbpAccountName	result	When this method returns, the parsed GbpAccountName, 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}/gbpAccounts/{gbp_account}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GbpAccountName, GbpAccountName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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