Class PromotionName

Resource name for the Promotion resource.

Inheritance

object

PromotionName

Implements

IResourceName

IEquatable<PromotionName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Promotions.V1Beta

Assembly: Google.Shopping.Merchant.Promotions.V1Beta.dll

Syntax

public sealed class PromotionName : IResourceName, IEquatable<PromotionName>

Constructors

PromotionName(string, string)

Constructs a new instance of a PromotionName class from the component parts of pattern accounts/{account}/promotions/{promotion}

Declaration

public PromotionName(string accountId, string promotionId)

Parameters

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

PromotionId

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

Declaration

public string PromotionId { get; }

Property Value

Type	Description
string

Type

The PromotionName.ResourceNameType of the contained resource name.

Declaration

public PromotionName.ResourceNameType Type { get; }

Property Value

Type	Description
PromotionName.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)

Formats the IDs into the string representation of this PromotionName with pattern accounts/{account}/promotions/{promotion}.

Declaration

public static string Format(string accountId, string promotionId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	promotionId	The Promotion ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PromotionName with pattern accounts/{account}/promotions/{promotion}.

FormatAccountPromotion(string, string)

Formats the IDs into the string representation of this PromotionName with pattern accounts/{account}/promotions/{promotion}.

Declaration

public static string FormatAccountPromotion(string accountId, string promotionId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	promotionId	The Promotion ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this PromotionName with pattern accounts/{account}/promotions/{promotion}.

FromAccountPromotion(string, string)

Creates a PromotionName with the pattern accounts/{account}/promotions/{promotion}.

Declaration

public static PromotionName FromAccountPromotion(string accountId, string promotionId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	promotionId	The Promotion ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a PromotionName containing an unparsed resource name.

Declaration

public static PromotionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static PromotionName Parse(string promotionName)

Parameters

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

Returns

Type	Description
PromotionName	The parsed PromotionName if successful.

Remarks

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

• accounts/{account}/promotions/{promotion}

Parse(string, bool)

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

Declaration

public static PromotionName Parse(string promotionName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/promotions/{promotion}

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

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

Declaration

public static bool TryParse(string promotionName, out PromotionName result)

Parameters

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

TryParse(string, bool, out PromotionName)

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

Declaration

public static bool TryParse(string promotionName, bool allowUnparsed, out PromotionName result)

Parameters

Type	Name	Description
string	promotionName	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.
PromotionName	result	When this method returns, the parsed PromotionName, 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}/promotions/{promotion}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PromotionName, PromotionName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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