Retail v2 API - Class ProductName (2.16.0) 

public sealed class ProductName : IResourceName, IEquatable<ProductName>

Reference documentation and code samples for the Retail v2 API class ProductName.

Resource name for the Product resource.

Inheritance

object > ProductName

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ProductName(string, string, string, string, string)

public ProductName(string projectId, string locationId, string catalogId, string branchId, string productId)

Constructs a new instance of a ProductName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
branchId string

The Branch ID. Must not be null or empty.
productId string

The Product ID. Must not be null or empty.

Properties

BranchId

public string BranchId { get; }

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

Property Value
Type Description
string

CatalogId

public string CatalogId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

ProductId

public string ProductId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public ProductName.ResourceNameType Type { get; }

The ProductName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProductNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string catalogId, string branchId, string productId)

Formats the IDs into the string representation of this ProductName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
branchId string

The Branch ID. Must not be null or empty.
productId string

The Product ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ProductName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.

FormatProjectLocationCatalogBranchProduct(string, string, string, string, string)

public static string FormatProjectLocationCatalogBranchProduct(string projectId, string locationId, string catalogId, string branchId, string productId)

Formats the IDs into the string representation of this ProductName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
branchId string

The Branch ID. Must not be null or empty.
productId string

The Product ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ProductName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.

FromProjectLocationCatalogBranchProduct(string, string, string, string, string)

public static ProductName FromProjectLocationCatalogBranchProduct(string projectId, string locationId, string catalogId, string branchId, string productId)

Creates a ProductName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
branchId string

The Branch ID. Must not be null or empty.
productId string

The Product ID. Must not be null or empty.
Returns
Type Description
ProductName

A new instance of ProductName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProductName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProductName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ProductName

A new instance of ProductName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ProductName Parse(string productName)

Parses the given resource name string into a new ProductName instance.

Parameter
Name Description
productName string

The resource name in string form. Must not be null.
Returns
Type Description
ProductName

The parsed ProductName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}

Parse(string, bool)

public static ProductName Parse(string productName, bool allowUnparsed)

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

Parameters
Name Description
productName string

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

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
ProductName

The parsed ProductName if successful.
Remarks

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

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out ProductName)

public static bool TryParse(string productName, out ProductName result)

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

Parameters
Name Description
productName string

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

When this method returns, the parsed ProductName, 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:

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}

TryParse(string, bool, out ProductName)

public static bool TryParse(string productName, bool allowUnparsed, out ProductName result)

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

Parameters
Name Description
productName string

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

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.
result ProductName

When this method returns, the parsed ProductName, 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:

  • projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProductName, ProductName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ProductName

The first resource name to compare, or null.
b ProductName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ProductName

The first resource name to compare, or null.
b ProductName

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.