Class LocalInventoryName

Resource name for the LocalInventory resource.

Inheritance

object

LocalInventoryName

Implements

IResourceName

IEquatable<LocalInventoryName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Inventories.V1

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

Syntax

public sealed class LocalInventoryName : IResourceName, IEquatable<LocalInventoryName>

Constructors

LocalInventoryName(string, string, string)

Constructs a new instance of a LocalInventoryName class from the component parts of pattern accounts/{account}/products/{product}/localInventories/{store_code}

Declaration

public LocalInventoryName(string accountId, string productId, string storeCodeId)

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	storeCodeId	The StoreCode 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

StoreCodeId

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

Declaration

public string StoreCodeId { get; }

Property Value

Type	Description
string

Type

The LocalInventoryName.ResourceNameType of the contained resource name.

Declaration

public LocalInventoryName.ResourceNameType Type { get; }

Property Value

Type	Description
LocalInventoryName.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 LocalInventoryName with pattern accounts/{account}/products/{product}/localInventories/{store_code}.

Declaration

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

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	storeCodeId	The StoreCode ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this LocalInventoryName with pattern accounts/{account}/products/{product}/localInventories/{store_code}.

FormatAccountProductStoreCode(string, string, string)

Formats the IDs into the string representation of this LocalInventoryName with pattern accounts/{account}/products/{product}/localInventories/{store_code}.

Declaration

public static string FormatAccountProductStoreCode(string accountId, string productId, string storeCodeId)

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	storeCodeId	The StoreCode ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this LocalInventoryName with pattern accounts/{account}/products/{product}/localInventories/{store_code}.

FromAccountProductStoreCode(string, string, string)

Creates a LocalInventoryName with the pattern accounts/{account}/products/{product}/localInventories/{store_code}.

Declaration

public static LocalInventoryName FromAccountProductStoreCode(string accountId, string productId, string storeCodeId)

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	storeCodeId	The StoreCode ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a LocalInventoryName containing an unparsed resource name.

Declaration

public static LocalInventoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static LocalInventoryName Parse(string localInventoryName)

Parameters

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

Returns

Type	Description
LocalInventoryName	The parsed LocalInventoryName if successful.

Remarks

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

• accounts/{account}/products/{product}/localInventories/{store_code}

Parse(string, bool)

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

Declaration

public static LocalInventoryName Parse(string localInventoryName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/products/{product}/localInventories/{store_code}

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

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

Declaration

public static bool TryParse(string localInventoryName, out LocalInventoryName result)

Parameters

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

TryParse(string, bool, out LocalInventoryName)

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

Declaration

public static bool TryParse(string localInventoryName, bool allowUnparsed, out LocalInventoryName result)

Parameters

Type	Name	Description
string	localInventoryName	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.
LocalInventoryName	result	When this method returns, the parsed LocalInventoryName, 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}/localInventories/{store_code}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LocalInventoryName, LocalInventoryName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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