Class LfpInventoryName

Resource name for the LfpInventory resource.

Inheritance

object

LfpInventoryName

Implements

IResourceName

IEquatable<LfpInventoryName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Lfp.V1

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

Syntax

public sealed class LfpInventoryName : IResourceName, IEquatable<LfpInventoryName>

Constructors

LfpInventoryName(string, string, string, string)

Constructs a new instance of a LfpInventoryName class from the component parts of pattern accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

Declaration

public LfpInventoryName(string accountId, string targetMerchantId, string storeCodeId, string offerId)

Parameters

Type	Name	Description
string	accountId	The `Account` ID. Must not be `null` or empty.
string	targetMerchantId	The `TargetMerchant` ID. Must not be `null` or empty.
string	storeCodeId	The `StoreCode` ID. Must not be `null` or empty.
string	offerId	The `Offer` 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

OfferId

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

Declaration

public string OfferId { 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

TargetMerchantId

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

Declaration

public string TargetMerchantId { get; }

Property Value

Type	Description
string

Type

The LfpInventoryName.ResourceNameType of the contained resource name.

Declaration

public LfpInventoryName.ResourceNameType Type { get; }

Property Value

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

Formats the IDs into the string representation of this LfpInventoryName with pattern accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}.

Declaration

public static string Format(string accountId, string targetMerchantId, string storeCodeId, string offerId)

Parameters

Type	Name	Description
string	accountId	The `Account` ID. Must not be `null` or empty.
string	targetMerchantId	The `TargetMerchant` ID. Must not be `null` or empty.
string	storeCodeId	The `StoreCode` ID. Must not be `null` or empty.
string	offerId	The `Offer` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this LfpInventoryName with pattern `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}`.

FormatAccountTargetMerchantStoreCodeOffer(string, string, string, string)

Formats the IDs into the string representation of this LfpInventoryName with pattern accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}.

Declaration

public static string FormatAccountTargetMerchantStoreCodeOffer(string accountId, string targetMerchantId, string storeCodeId, string offerId)

Parameters

Type	Name	Description
string	accountId	The `Account` ID. Must not be `null` or empty.
string	targetMerchantId	The `TargetMerchant` ID. Must not be `null` or empty.
string	storeCodeId	The `StoreCode` ID. Must not be `null` or empty.
string	offerId	The `Offer` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this LfpInventoryName with pattern `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}`.

FromAccountTargetMerchantStoreCodeOffer(string, string, string, string)

Creates a LfpInventoryName with the pattern accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}.

Declaration

public static LfpInventoryName FromAccountTargetMerchantStoreCodeOffer(string accountId, string targetMerchantId, string storeCodeId, string offerId)

Parameters

Type	Name	Description
string	accountId	The `Account` ID. Must not be `null` or empty.
string	targetMerchantId	The `TargetMerchant` ID. Must not be `null` or empty.
string	storeCodeId	The `StoreCode` ID. Must not be `null` or empty.
string	offerId	The `Offer` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a LfpInventoryName containing an unparsed resource name.

Declaration

public static LfpInventoryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static LfpInventoryName Parse(string lfpInventoryName)

Parameters

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

Returns

Type	Description
LfpInventoryName	The parsed LfpInventoryName if successful.

Remarks

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

accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

Parse(string, bool)

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

Declaration

public static LfpInventoryName Parse(string lfpInventoryName, bool allowUnparsed)

Parameters

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

Remarks

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

accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

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

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

Declaration

public static bool TryParse(string lfpInventoryName, out LfpInventoryName result)

Parameters

Type	Name	Description
string	lfpInventoryName	The resource name in string form. Must not be `null`.
LfpInventoryName	result	When this method returns, the parsed LfpInventoryName, 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}/lfpInventories/{target_merchant}~{store_code}~{offer}

TryParse(string, bool, out LfpInventoryName)

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

Declaration

public static bool TryParse(string lfpInventoryName, bool allowUnparsed, out LfpInventoryName result)

Parameters

Type	Name	Description
string	lfpInventoryName	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.
LfpInventoryName	result	When this method returns, the parsed LfpInventoryName, 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}/lfpInventories/{target_merchant}~{store_code}~{offer}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LfpInventoryName, LfpInventoryName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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