Recommendations AI v1beta1 API - Class CatalogItemPathName (2.0.0-beta02)

public sealed class CatalogItemPathName : IResourceName, IEquatable<CatalogItemPathName>

Reference documentation and code samples for the Recommendations AI v1beta1 API class CatalogItemPathName.

Resource name for the CatalogItemPath resource.

Inheritance

Object > CatalogItemPathName

Implements

IResourceName, IEquatable<CatalogItemPathName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

CatalogItemPathName(String, String, String, String)

public CatalogItemPathName(string projectId, string locationId, string catalogId, string catalogItemPathId)

Constructs a new instance of a CatalogItemPathName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}

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.
catalogItemPathId	`String` The `CatalogItemPath` ID. Must not be `null` or empty.

Properties

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

CatalogItemPathId

public string CatalogItemPathId { get; }

The CatalogItemPath 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
Boolean

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

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 CatalogItemPathName.ResourceNameType Type { get; }

The CatalogItemPathName.ResourceNameType of the contained resource name.

Property Value

Type	Description
CatalogItemPathName.ResourceNameType

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)

public static string Format(string projectId, string locationId, string catalogId, string catalogItemPathId)

Formats the IDs into the string representation of this CatalogItemPathName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}.

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.
catalogItemPathId	`String` The `CatalogItemPath` ID. Must not be `null` or empty.

Returns

Type	Description
String	The string representation of this CatalogItemPathName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}`.

FormatProjectLocationCatalogCatalogItemPath(String, String, String, String)

public static string FormatProjectLocationCatalogCatalogItemPath(string projectId, string locationId, string catalogId, string catalogItemPathId)

Formats the IDs into the string representation of this CatalogItemPathName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}.

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.
catalogItemPathId	`String` The `CatalogItemPath` ID. Must not be `null` or empty.

Returns

Type	Description
String	The string representation of this CatalogItemPathName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}`.

FromProjectLocationCatalogCatalogItemPath(String, String, String, String)

public static CatalogItemPathName FromProjectLocationCatalogCatalogItemPath(string projectId, string locationId, string catalogId, string catalogItemPathId)

Creates a CatalogItemPathName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}.

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.
catalogItemPathId	`String` The `CatalogItemPath` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

public static CatalogItemPathName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CatalogItemPathName containing an unparsed resource name.

Parameter

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

Returns

Type	Description
CatalogItemPathName	A new instance of CatalogItemPathName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static CatalogItemPathName Parse(string catalogItemPathName)

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

Parameter

Name	Description
catalogItemPathName	`String` The resource name in string form. Must not be `null`.

Returns

Type	Description
CatalogItemPathName	The parsed CatalogItemPathName if successful.

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}

Parse(String, Boolean)

public static CatalogItemPathName Parse(string catalogItemPathName, bool allowUnparsed)

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

Parameters

Name	Description
catalogItemPathName	`String` The resource name in string form. Must not be `null`.
allowUnparsed	`Boolean` 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
CatalogItemPathName	The parsed CatalogItemPathName if successful.

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}

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

Object.ToString()

TryParse(String, out CatalogItemPathName)

public static bool TryParse(string catalogItemPathName, out CatalogItemPathName result)

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

Parameters

Name	Description
catalogItemPathName	`String` The resource name in string form. Must not be `null`.
result	`CatalogItemPathName` When this method returns, the parsed CatalogItemPathName, or `null` if parsing failed.

Returns

Type	Description
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}/catalogItems/{catalog_item_path}

TryParse(String, Boolean, out CatalogItemPathName)

public static bool TryParse(string catalogItemPathName, bool allowUnparsed, out CatalogItemPathName result)

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

Parameters

Name	Description
catalogItemPathName	`String` The resource name in string form. Must not be `null`.
allowUnparsed	`Boolean` 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	`CatalogItemPathName` When this method returns, the parsed CatalogItemPathName, or `null` if parsing failed.

Returns

Type	Description
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}/catalogItems/{catalog_item_path}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CatalogItemPathName, CatalogItemPathName)

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

Parameters

Name	Description
a	`CatalogItemPathName`
b	`CatalogItemPathName`

Returns

Type	Description
Boolean

Inequality(CatalogItemPathName, CatalogItemPathName)

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

Parameters

Name	Description
a	`CatalogItemPathName`
b	`CatalogItemPathName`

Returns

Type	Description
Boolean