Class CatalogName

Resource name for the Catalog resource.

Inheritance

System.Object

CatalogName

Implements

IResourceName

System.IEquatable<CatalogName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Retail.V2

Assembly: Google.Cloud.Retail.V2.dll

Syntax

public sealed class CatalogName : IResourceName, IEquatable<CatalogName>

Constructors

CatalogName(String, String, String)

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

Declaration

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

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.

Properties

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

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 CatalogName.ResourceNameType of the contained resource name.

Declaration

public CatalogName.ResourceNameType Type { get; }

Property Value

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

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

Declaration

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

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.

Returns

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

FormatProjectLocationCatalog(String, String, String)

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

Declaration

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

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.

Returns

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

FromProjectLocationCatalog(String, String, String)

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

Declaration

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

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.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a CatalogName containing an unparsed resource name.

Declaration

public static CatalogName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

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 CatalogName instance.

Declaration

public static CatalogName Parse(string catalogName)

Parameters

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

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

Declaration

public static CatalogName Parse(string catalogName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	catalogName	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
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()

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

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

Declaration

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

Parameters

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

TryParse(String, Boolean, out CatalogName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	catalogName	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.
CatalogName	result	When this method returns, the parsed CatalogName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CatalogName, CatalogName)

Declaration

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

Parameters

Type	Name	Description
CatalogName	a
CatalogName	b

Returns

Type	Description
System.Boolean

Inequality(CatalogName, CatalogName)

Declaration

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

Parameters

Type	Name	Description
CatalogName	a
CatalogName	b

Returns

Type	Description
System.Boolean