public sealed class CatalogItemPathName : IResourceName, IEquatable<CatalogItemPathName>
Resource name for the CatalogItemPath
resource.
Namespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
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=**}
Type | Name | Description |
---|---|---|
String | projectId | The |
String | locationId | The |
String | catalogId | The |
String | catalogItemPathId | The |
Properties
CatalogId
public string CatalogId { get; }
The Catalog
ID. Will not be null
, unless this instance contains an unparsed resource name.
Type | Description |
---|---|
String |
CatalogItemPathId
public string CatalogItemPathId { get; }
The CatalogItemPath
ID. Will not be null
, unless this instance contains an unparsed resource
name.
Type | Description |
---|---|
String |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Type | Description |
---|---|
Boolean |
LocationId
public string LocationId { get; }
The Location
ID. Will not be null
, unless this instance contains an unparsed resource name.
Type | Description |
---|---|
String |
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Type | Description |
---|---|
String |
Type
public CatalogItemPathName.ResourceNameType Type { get; }
The CatalogItemPathName.ResourceNameType of the contained resource name.
Type | Description |
---|---|
CatalogItemPathName.ResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
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=**}
.
Type | Name | Description |
---|---|---|
String | projectId | The |
String | locationId | The |
String | catalogId | The |
String | catalogItemPathId | The |
Type | Description |
---|---|
String | The string representation of this CatalogItemPathName with pattern
|
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=**}
.
Type | Name | Description |
---|---|---|
String | projectId | The |
String | locationId | The |
String | catalogId | The |
String | catalogItemPathId | The |
Type | Description |
---|---|
String | The string representation of this CatalogItemPathName with pattern
|
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=**}
.
Type | Name | Description |
---|---|---|
String | projectId | The |
String | locationId | The |
String | catalogId | The |
String | catalogItemPathId | The |
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.
Type | Name | Description |
---|---|---|
UnparsedResourceName | unparsedResourceName | The unparsed resource name. Must not be |
Type | Description |
---|---|
CatalogItemPathName | A new instance of CatalogItemPathName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Type | Description |
---|---|
Int32 |
Parse(String)
public static CatalogItemPathName Parse(string catalogItemPathName)
Parses the given resource name string into a new CatalogItemPathName instance.
Type | Name | Description |
---|---|---|
String | catalogItemPathName | The resource name in string form. Must not be |
Type | Description |
---|---|
CatalogItemPathName | The parsed CatalogItemPathName if successful. |
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.
Type | Name | Description |
---|---|---|
String | catalogItemPathName | The resource name in string form. Must not be |
Boolean | allowUnparsed | If |
Type | Description |
---|---|
CatalogItemPathName | The parsed CatalogItemPathName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path=**}
allowUnparsed
is true
.
ToString()
public override string ToString()
The string representation of the resource name.
Type | Description |
---|---|
String | The string representation of the resource name. |
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.
Type | Name | Description |
---|---|---|
String | catalogItemPathName | The resource name in string form. Must not be |
CatalogItemPathName | result | When this method returns, the parsed CatalogItemPathName, or |
Type | Description |
---|---|
Boolean |
|
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.
Type | Name | Description |
---|---|---|
String | catalogItemPathName | The resource name in string form. Must not be |
Boolean | allowUnparsed | If |
CatalogItemPathName | result | When this method returns, the parsed CatalogItemPathName, or |
Type | Description |
---|---|
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path=**}
allowUnparsed
is true
.
Operators
Equality(CatalogItemPathName, CatalogItemPathName)
public static bool operator ==(CatalogItemPathName a, CatalogItemPathName b)
Type | Name | Description |
---|---|---|
CatalogItemPathName | a | |
CatalogItemPathName | b |
Type | Description |
---|---|
Boolean |
Inequality(CatalogItemPathName, CatalogItemPathName)
public static bool operator !=(CatalogItemPathName a, CatalogItemPathName b)
Type | Name | Description |
---|---|---|
CatalogItemPathName | a | |
CatalogItemPathName | b |
Type | Description |
---|---|
Boolean |