Class RegionalInventoryName

Resource name for the RegionalInventory resource.

Inheritance

object

RegionalInventoryName

Implements

IResourceName

IEquatable<RegionalInventoryName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Inventories.V1

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

Syntax

public sealed class RegionalInventoryName : IResourceName, IEquatable<RegionalInventoryName>

Constructors

RegionalInventoryName(string, string, string)

Constructs a new instance of a RegionalInventoryName class from the component parts of pattern accounts/{account}/products/{product}/regionalInventories/{region}

Declaration

public RegionalInventoryName(string accountId, string productId, string regionId)

Parameters

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

ProductId

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

Declaration

public string ProductId { get; }

Property Value

Type	Description
string

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 RegionalInventoryName.ResourceNameType of the contained resource name.

Declaration

public RegionalInventoryName.ResourceNameType Type { get; }

Property Value

Type	Description
RegionalInventoryName.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, string)

Formats the IDs into the string representation of this RegionalInventoryName with pattern accounts/{account}/products/{product}/regionalInventories/{region}.

Declaration

public static string Format(string accountId, string productId, string regionId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	productId	The Product 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 RegionalInventoryName with pattern accounts/{account}/products/{product}/regionalInventories/{region}.

FormatAccountProductRegion(string, string, string)

Formats the IDs into the string representation of this RegionalInventoryName with pattern accounts/{account}/products/{product}/regionalInventories/{region}.

Declaration

public static string FormatAccountProductRegion(string accountId, string productId, string regionId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	productId	The Product 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 RegionalInventoryName with pattern accounts/{account}/products/{product}/regionalInventories/{region}.

FromAccountProductRegion(string, string, string)

Creates a RegionalInventoryName with the pattern accounts/{account}/products/{product}/regionalInventories/{region}.

Declaration

public static RegionalInventoryName FromAccountProductRegion(string accountId, string productId, string regionId)

Parameters

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

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a RegionalInventoryName containing an unparsed resource name.

Declaration

public static RegionalInventoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static RegionalInventoryName Parse(string regionalInventoryName)

Parameters

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

Returns

Type	Description
RegionalInventoryName	The parsed RegionalInventoryName if successful.

Remarks

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

• accounts/{account}/products/{product}/regionalInventories/{region}

Parse(string, bool)

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

Declaration

public static RegionalInventoryName Parse(string regionalInventoryName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/products/{product}/regionalInventories/{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 RegionalInventoryName)

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

Declaration

public static bool TryParse(string regionalInventoryName, out RegionalInventoryName result)

Parameters

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

TryParse(string, bool, out RegionalInventoryName)

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

Declaration

public static bool TryParse(string regionalInventoryName, bool allowUnparsed, out RegionalInventoryName result)

Parameters

Type	Name	Description
string	regionalInventoryName	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.
RegionalInventoryName	result	When this method returns, the parsed RegionalInventoryName, 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}/products/{product}/regionalInventories/{region}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RegionalInventoryName, RegionalInventoryName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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