Class ProductReviewName

Resource name for the ProductReview resource.

Inheritance

object

ProductReviewName

Implements

IResourceName

IEquatable<ProductReviewName>

Inherited Members

object.GetType()

Namespace: Google.Shopping.Merchant.Reviews.V1Beta

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

Syntax

public sealed class ProductReviewName : IResourceName, IEquatable<ProductReviewName>

Constructors

ProductReviewName(string, string)

Constructs a new instance of a ProductReviewName class from the component parts of pattern accounts/{account}/productReviews/{productreview}

Declaration

public ProductReviewName(string accountId, string productreviewId)

Parameters

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

ProductreviewId

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

Declaration

public string ProductreviewId { get; }

Property Value

Type	Description
string

Type

The ProductReviewName.ResourceNameType of the contained resource name.

Declaration

public ProductReviewName.ResourceNameType Type { get; }

Property Value

Type	Description
ProductReviewName.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 ProductReviewName with pattern accounts/{account}/productReviews/{productreview}.

Declaration

public static string Format(string accountId, string productreviewId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	productreviewId	The Productreview ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ProductReviewName with pattern accounts/{account}/productReviews/{productreview}.

FormatAccountProductreview(string, string)

Formats the IDs into the string representation of this ProductReviewName with pattern accounts/{account}/productReviews/{productreview}.

Declaration

public static string FormatAccountProductreview(string accountId, string productreviewId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	productreviewId	The Productreview ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this ProductReviewName with pattern accounts/{account}/productReviews/{productreview}.

FromAccountProductreview(string, string)

Creates a ProductReviewName with the pattern accounts/{account}/productReviews/{productreview}.

Declaration

public static ProductReviewName FromAccountProductreview(string accountId, string productreviewId)

Parameters

Type	Name	Description
string	accountId	The Account ID. Must not be null or empty.
string	productreviewId	The Productreview ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ProductReviewName containing an unparsed resource name.

Declaration

public static ProductReviewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ProductReviewName Parse(string productReviewName)

Parameters

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

Returns

Type	Description
ProductReviewName	The parsed ProductReviewName if successful.

Remarks

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

• accounts/{account}/productReviews/{productreview}

Parse(string, bool)

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

Declaration

public static ProductReviewName Parse(string productReviewName, bool allowUnparsed)

Parameters

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

Remarks

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

• accounts/{account}/productReviews/{productreview}

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

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

Declaration

public static bool TryParse(string productReviewName, out ProductReviewName result)

Parameters

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

TryParse(string, bool, out ProductReviewName)

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

Declaration

public static bool TryParse(string productReviewName, bool allowUnparsed, out ProductReviewName result)

Parameters

Type	Name	Description
string	productReviewName	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.
ProductReviewName	result	When this method returns, the parsed ProductReviewName, 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}/productReviews/{productreview}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProductReviewName, ProductReviewName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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