Retail v2 API - Class CatalogName (2.8.0)

public sealed class CatalogName : IResourceName, IEquatable<CatalogName>

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

Resource name for the Catalog resource.

Inheritance

object > CatalogName

Implements

IResourceName, IEquatable CatalogName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CatalogName(string, string, string)

public CatalogName(string projectId, string locationId, string catalogId)

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

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.

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`

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

The CatalogName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CatalogNameResourceNameType`

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)

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

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

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.

Returns
Type	Description
`string`	The string representation of this CatalogName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}`.

FormatProjectLocationCatalog(string, string, string)

public static string FormatProjectLocationCatalog(string projectId, string locationId, string catalogId)

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

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.

Returns
Type	Description
`string`	The string representation of this CatalogName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}`.

FromProjectLocationCatalog(string, string, string)

public static CatalogName FromProjectLocationCatalog(string projectId, string locationId, string catalogId)

Creates a CatalogName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}.

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.

Returns
Type	Description
`CatalogName`	A new instance of CatalogName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CatalogName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CatalogName containing an unparsed resource name.

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

Returns
Type	Description
`CatalogName`	A new instance of CatalogName 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 CatalogName Parse(string catalogName)

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

Parameter
Name	Description
`catalogName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`CatalogName`	The parsed CatalogName if successful.

Remarks

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

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

Parse(string, bool)

public static CatalogName Parse(string catalogName, bool allowUnparsed)

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

Parameters
Name	Description
`catalogName`	`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
`CatalogName`	The parsed CatalogName if successful.

Remarks

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

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

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

public static bool TryParse(string catalogName, out CatalogName result)

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

Parameters
Name	Description
`catalogName`	`string` The resource name in string form. Must not be `null`.
`result`	`CatalogName` When this method returns, the parsed CatalogName, 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}

TryParse(string, bool, out CatalogName)

public static bool TryParse(string catalogName, bool allowUnparsed, out CatalogName result)

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

Parameters
Name	Description
`catalogName`	`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`	`CatalogName` When this method returns, the parsed CatalogName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CatalogName, CatalogName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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