Class BusinessIdentityName

Resource name for the BusinessIdentity resource.

Inheritance

object

BusinessIdentityName

Implements

IResourceName

IEquatable<BusinessIdentityName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class BusinessIdentityName : IResourceName, IEquatable<BusinessIdentityName>

Constructors

BusinessIdentityName(string)

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

Declaration

public BusinessIdentityName(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 BusinessIdentityName.ResourceNameType of the contained resource name.

Declaration

public BusinessIdentityName.ResourceNameType Type { get; }

Property Value

Type	Description
BusinessIdentityName.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 BusinessIdentityName with pattern accounts/{account}/businessIdentity.

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 BusinessIdentityName with pattern accounts/{account}/businessIdentity.

FormatAccount(string)

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

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 BusinessIdentityName with pattern accounts/{account}/businessIdentity.

FromAccount(string)

Creates a BusinessIdentityName with the pattern accounts/{account}/businessIdentity.

Declaration

public static BusinessIdentityName FromAccount(string accountId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a BusinessIdentityName containing an unparsed resource name.

Declaration

public static BusinessIdentityName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static BusinessIdentityName Parse(string businessIdentityName)

Parameters

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

Returns

Type	Description
BusinessIdentityName	The parsed BusinessIdentityName if successful.

Remarks

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

• accounts/{account}/businessIdentity

Parse(string, bool)

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

Declaration

public static BusinessIdentityName Parse(string businessIdentityName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/businessIdentity

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

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

Declaration

public static bool TryParse(string businessIdentityName, out BusinessIdentityName result)

Parameters

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

TryParse(string, bool, out BusinessIdentityName)

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

Declaration

public static bool TryParse(string businessIdentityName, bool allowUnparsed, out BusinessIdentityName result)

Parameters

Type	Name	Description
string	businessIdentityName	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.
BusinessIdentityName	result	When this method returns, the parsed BusinessIdentityName, 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}/businessIdentity

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BusinessIdentityName, BusinessIdentityName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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