Class LfpStoreName

Resource name for the LfpStore resource.

Inheritance

object

LfpStoreName

Implements

IResourceName

IEquatable<LfpStoreName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Lfp.V1

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

Syntax

public sealed class LfpStoreName : IResourceName, IEquatable<LfpStoreName>

Constructors

LfpStoreName(string, string, string)

Constructs a new instance of a LfpStoreName class from the component parts of pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}

Declaration

public LfpStoreName(string accountId, string targetMerchantId, string storeCodeId)

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.

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

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

Declaration

public LfpStoreName.ResourceNameType Type { get; }

Property Value

Type	Description
LfpStoreName.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 LfpStoreName with pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}.

Declaration

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

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.

Returns

Type	Description
string	The string representation of this LfpStoreName with pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}.

FormatAccountTargetMerchantStoreCode(string, string, string)

Formats the IDs into the string representation of this LfpStoreName with pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}.

Declaration

public static string FormatAccountTargetMerchantStoreCode(string accountId, string targetMerchantId, string storeCodeId)

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.

Returns

Type	Description
string	The string representation of this LfpStoreName with pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}.

FromAccountTargetMerchantStoreCode(string, string, string)

Creates a LfpStoreName with the pattern accounts/{account}/lfpStores/{target_merchant}~{store_code}.

Declaration

public static LfpStoreName FromAccountTargetMerchantStoreCode(string accountId, string targetMerchantId, string storeCodeId)

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.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a LfpStoreName containing an unparsed resource name.

Declaration

public static LfpStoreName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static LfpStoreName Parse(string lfpStoreName)

Parameters

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

Returns

Type	Description
LfpStoreName	The parsed LfpStoreName if successful.

Remarks

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

• accounts/{account}/lfpStores/{target_merchant}~{store_code}

Parse(string, bool)

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

Declaration

public static LfpStoreName Parse(string lfpStoreName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/lfpStores/{target_merchant}~{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 LfpStoreName)

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

Declaration

public static bool TryParse(string lfpStoreName, out LfpStoreName result)

Parameters

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

TryParse(string, bool, out LfpStoreName)

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

Declaration

public static bool TryParse(string lfpStoreName, bool allowUnparsed, out LfpStoreName result)

Parameters

Type	Name	Description
string	lfpStoreName	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.
LfpStoreName	result	When this method returns, the parsed LfpStoreName, 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}/lfpStores/{target_merchant}~{store_code}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LfpStoreName, LfpStoreName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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