Show / Hide Table of Contents

Class LfpProviderName

Resource name for the LfpProvider resource.

Inheritance
object
LfpProviderName
Implements
IResourceName
IEquatable<LfpProviderName>
Inherited Members
object.GetType()
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public sealed class LfpProviderName : IResourceName, IEquatable<LfpProviderName>

Constructors

LfpProviderName(string, string, string)

Constructs a new instance of a LfpProviderName class from the component parts of pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}

Declaration
public LfpProviderName(string accountId, string omnichannelSettingId, string lfpProviderId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

string omnichannelSettingId

The OmnichannelSetting ID. Must not be null or empty.

string lfpProviderId

The LfpProvider 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

LfpProviderId

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

Declaration
public string LfpProviderId { get; }
Property Value
Type Description
string

OmnichannelSettingId

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

Declaration
public string OmnichannelSettingId { get; }
Property Value
Type Description
string

Type

The LfpProviderName.ResourceNameType of the contained resource name.

Declaration
public LfpProviderName.ResourceNameType Type { get; }
Property Value
Type Description
LfpProviderName.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 LfpProviderName with pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}.

Declaration
public static string Format(string accountId, string omnichannelSettingId, string lfpProviderId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

string omnichannelSettingId

The OmnichannelSetting ID. Must not be null or empty.

string lfpProviderId

The LfpProvider ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LfpProviderName with pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}.

FormatAccountOmnichannelSettingLfpProvider(string, string, string)

Formats the IDs into the string representation of this LfpProviderName with pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}.

Declaration
public static string FormatAccountOmnichannelSettingLfpProvider(string accountId, string omnichannelSettingId, string lfpProviderId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

string omnichannelSettingId

The OmnichannelSetting ID. Must not be null or empty.

string lfpProviderId

The LfpProvider ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LfpProviderName with pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}.

FromAccountOmnichannelSettingLfpProvider(string, string, string)

Creates a LfpProviderName with the pattern accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}.

Declaration
public static LfpProviderName FromAccountOmnichannelSettingLfpProvider(string accountId, string omnichannelSettingId, string lfpProviderId)
Parameters
Type Name Description
string accountId

The Account ID. Must not be null or empty.

string omnichannelSettingId

The OmnichannelSetting ID. Must not be null or empty.

string lfpProviderId

The LfpProvider ID. Must not be null or empty.

Returns
Type Description
LfpProviderName

A new instance of LfpProviderName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a LfpProviderName containing an unparsed resource name.

Declaration
public static LfpProviderName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type Name Description
UnparsedResourceName unparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
LfpProviderName

A new instance of LfpProviderName 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 LfpProviderName instance.

Declaration
public static LfpProviderName Parse(string lfpProviderName)
Parameters
Type Name Description
string lfpProviderName

The resource name in string form. Must not be null.

Returns
Type Description
LfpProviderName

The parsed LfpProviderName if successful.

Remarks

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

  • accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}

Parse(string, bool)

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

Declaration
public static LfpProviderName Parse(string lfpProviderName, bool allowUnparsed)
Parameters
Type Name Description
string lfpProviderName

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
LfpProviderName

The parsed LfpProviderName if successful.

Remarks

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

  • accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}
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 LfpProviderName)

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

Declaration
public static bool TryParse(string lfpProviderName, out LfpProviderName result)
Parameters
Type Name Description
string lfpProviderName

The resource name in string form. Must not be null.

LfpProviderName result

When this method returns, the parsed LfpProviderName, 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}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}

TryParse(string, bool, out LfpProviderName)

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

Declaration
public static bool TryParse(string lfpProviderName, bool allowUnparsed, out LfpProviderName result)
Parameters
Type Name Description
string lfpProviderName

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.

LfpProviderName result

When this method returns, the parsed LfpProviderName, 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}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(LfpProviderName, LfpProviderName)

Determines whether two specified resource names have the same value.

Declaration
public static bool operator ==(LfpProviderName a, LfpProviderName b)
Parameters
Type Name Description
LfpProviderName a

The first resource name to compare, or null.

LfpProviderName 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 !=(LfpProviderName, LfpProviderName)

Determines whether two specified resource names have different values.

Declaration
public static bool operator !=(LfpProviderName a, LfpProviderName b)
Parameters
Type Name Description
LfpProviderName a

The first resource name to compare, or null.

LfpProviderName 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.

In this article
Back to top Generated by DocFX