Class RegionName

Resource name for the Region resource.

Inheritance

object

RegionName

Implements

IResourceName

IEquatable<RegionName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class RegionName : IResourceName, IEquatable<RegionName>

Constructors

RegionName(string, string)

Constructs a new instance of a RegionName class from the component parts of pattern accounts/{account}/regions/{region}

Declaration

public RegionName(string accountId, string regionId)

Parameters

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

RegionId

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

Declaration

public string RegionId { get; }

Property Value

Type	Description
string

Type

The RegionName.ResourceNameType of the contained resource name.

Declaration

public RegionName.ResourceNameType Type { get; }

Property Value

Type	Description
RegionName.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 RegionName with pattern accounts/{account}/regions/{region}.

Declaration

public static string Format(string accountId, string regionId)

Parameters

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

Returns

Type	Description
string	The string representation of this RegionName with pattern accounts/{account}/regions/{region}.

FormatAccountRegion(string, string)

Formats the IDs into the string representation of this RegionName with pattern accounts/{account}/regions/{region}.

Declaration

public static string FormatAccountRegion(string accountId, string regionId)

Parameters

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

Returns

Type	Description
string	The string representation of this RegionName with pattern accounts/{account}/regions/{region}.

FromAccountRegion(string, string)

Creates a RegionName with the pattern accounts/{account}/regions/{region}.

Declaration

public static RegionName FromAccountRegion(string accountId, string regionId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a RegionName containing an unparsed resource name.

Declaration

public static RegionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static RegionName Parse(string regionName)

Parameters

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

Returns

Type	Description
RegionName	The parsed RegionName if successful.

Remarks

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

• accounts/{account}/regions/{region}

Parse(string, bool)

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

Declaration

public static RegionName Parse(string regionName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/regions/{region}

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

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

Declaration

public static bool TryParse(string regionName, out RegionName result)

Parameters

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

TryParse(string, bool, out RegionName)

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

Declaration

public static bool TryParse(string regionName, bool allowUnparsed, out RegionName result)

Parameters

Type	Name	Description
string	regionName	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.
RegionName	result	When this method returns, the parsed RegionName, 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}/regions/{region}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RegionName, RegionName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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