Class AccountRelationshipName

Resource name for the AccountRelationship resource.

Inheritance

object

AccountRelationshipName

Implements

IResourceName

IEquatable<AccountRelationshipName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class AccountRelationshipName : IResourceName, IEquatable<AccountRelationshipName>

Constructors

AccountRelationshipName(string, string)

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

Declaration

public AccountRelationshipName(string accountId, string relationshipId)

Parameters

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

RelationshipId

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

Declaration

public string RelationshipId { get; }

Property Value

Type	Description
string

Type

The AccountRelationshipName.ResourceNameType of the contained resource name.

Declaration

public AccountRelationshipName.ResourceNameType Type { get; }

Property Value

Type	Description
AccountRelationshipName.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 AccountRelationshipName with pattern accounts/{account}/relationships/{relationship}.

Declaration

public static string Format(string accountId, string relationshipId)

Parameters

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

Returns

Type	Description
string	The string representation of this AccountRelationshipName with pattern accounts/{account}/relationships/{relationship}.

FormatAccountRelationship(string, string)

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

Declaration

public static string FormatAccountRelationship(string accountId, string relationshipId)

Parameters

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

Returns

Type	Description
string	The string representation of this AccountRelationshipName with pattern accounts/{account}/relationships/{relationship}.

FromAccountRelationship(string, string)

Creates a AccountRelationshipName with the pattern accounts/{account}/relationships/{relationship}.

Declaration

public static AccountRelationshipName FromAccountRelationship(string accountId, string relationshipId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AccountRelationshipName containing an unparsed resource name.

Declaration

public static AccountRelationshipName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AccountRelationshipName Parse(string accountRelationshipName)

Parameters

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

Returns

Type	Description
AccountRelationshipName	The parsed AccountRelationshipName if successful.

Remarks

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

• accounts/{account}/relationships/{relationship}

Parse(string, bool)

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

Declaration

public static AccountRelationshipName Parse(string accountRelationshipName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/relationships/{relationship}

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

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

Declaration

public static bool TryParse(string accountRelationshipName, out AccountRelationshipName result)

Parameters

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

TryParse(string, bool, out AccountRelationshipName)

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

Declaration

public static bool TryParse(string accountRelationshipName, bool allowUnparsed, out AccountRelationshipName result)

Parameters

Type	Name	Description
string	accountRelationshipName	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.
AccountRelationshipName	result	When this method returns, the parsed AccountRelationshipName, 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}/relationships/{relationship}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AccountRelationshipName, AccountRelationshipName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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