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

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

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
`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`

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
`CatalogItemPathNameResourceNameType`

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
`int`

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, bool)

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

TryParse(string, bool, 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`	`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`	`CatalogItemPathName` When this method returns, the parsed CatalogItemPathName, 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}/catalogItems/{catalog_item_path}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CatalogItemPathName, CatalogItemPathName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`CatalogItemPathName` The first resource name to compare, or null.
`b`	`CatalogItemPathName` 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.