Class ProductName

Resource name for the Product resource.

Inheritance

System.Object

ProductName

Implements

IResourceName

System.IEquatable<ProductName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Retail.V2

Assembly: Google.Cloud.Retail.V2.dll

Syntax

public sealed class ProductName : IResourceName, IEquatable<ProductName>

Constructors

ProductName(String, String, String, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.
System.String	productId	The Product ID. Must not be null or empty.

Properties

BranchId

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

Declaration

public string BranchId { get; }

Property Value

Type	Description
System.String

CatalogId

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

Declaration

public string CatalogId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

LocationId

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

Declaration

public string LocationId { get; }

Property Value

Type	Description
System.String

ProductId

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

Declaration

public string ProductId { get; }

Property Value

Type	Description
System.String

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The ProductName.ResourceNameType of the contained resource name.

Declaration

public ProductName.ResourceNameType Type { get; }

Property Value

Type	Description
ProductName.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, String, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.
System.String	productId	The Product ID. Must not be null or empty.

Returns

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.
System.String	productId	The Product ID. Must not be null or empty.

Returns

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	locationId	The Location ID. Must not be null or empty.
System.String	catalogId	The Catalog ID. Must not be null or empty.
System.String	branchId	The Branch ID. Must not be null or empty.
System.String	productId	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)

Creates a ProductName containing an unparsed resource name.

Declaration

public static ProductName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static ProductName Parse(string productName)

Parameters

Type	Name	Description
System.String	productName	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, Boolean)

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

Declaration

public static ProductName Parse(string productName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	productName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out ProductName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	productName	The resource name in string form. Must not be null.
ProductName	result	When this method returns, the parsed ProductName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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, Boolean, out ProductName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	productName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
ProductName	result	When this method returns, the parsed ProductName, or null if parsing failed.

Returns

Type	Description
System.Boolean	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

Equality(ProductName, ProductName)

Declaration

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

Parameters

Type	Name	Description
ProductName	a
ProductName	b

Returns

Type	Description
System.Boolean

Inequality(ProductName, ProductName)

Declaration

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

Parameters

Type	Name	Description
ProductName	a
ProductName	b

Returns

Type	Description
System.Boolean