Retail v2 API - Class AttributesConfigName (2.3.0)

public sealed class AttributesConfigName : IResourceName, IEquatable<AttributesConfigName>

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

Resource name for the AttributesConfig resource.

Inheritance

Object > AttributesConfigName

Implements

IResourceName, IEquatable<AttributesConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

AttributesConfigName(String, String, String)

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

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

Parameters
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`catalogId`	`System.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
`System.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
`System.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
`System.String`

Type

public AttributesConfigName.ResourceNameType Type { get; }

The AttributesConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AttributesConfigName.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)

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

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

Parameters
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`catalogId`	`System.String` The `Catalog` ID. Must not be `null` or empty.

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

FormatProjectLocationCatalog(String, String, String)

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

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

Parameters
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`catalogId`	`System.String` The `Catalog` ID. Must not be `null` or empty.

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

FromProjectLocationCatalog(String, String, String)

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

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

Parameters
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`catalogId`	`System.String` The `Catalog` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AttributesConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttributesConfigName containing an unparsed resource name.

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

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

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

Parameter
Name	Description
`attributesConfigName`	`System.String` The resource name in string form. Must not be `null`.

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

Remarks

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

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

Parse(String, Boolean)

public static AttributesConfigName Parse(string attributesConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`attributesConfigName`	`System.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 System.ArgumentException if an unparseable resource name is specified.

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

Remarks

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

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

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
`System.String`	The string representation of the resource name.

Overrides

Object.ToString()

TryParse(String, out AttributesConfigName)

public static bool TryParse(string attributesConfigName, out AttributesConfigName result)

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

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

TryParse(String, Boolean, out AttributesConfigName)

public static bool TryParse(string attributesConfigName, bool allowUnparsed, out AttributesConfigName result)

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

Parameters
Name	Description
`attributesConfigName`	`System.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 System.ArgumentException if an unparseable resource name is specified.
`result`	`AttributesConfigName` When this method returns, the parsed AttributesConfigName, 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}/attributesConfig

Or may be in any format if allowUnparsed is true.

Operators

Equality(AttributesConfigName, AttributesConfigName)

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

Parameters
Name	Description
`a`	`AttributesConfigName`
`b`	`AttributesConfigName`

Returns
Type	Description
`Boolean`

Inequality(AttributesConfigName, AttributesConfigName)

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

Parameters
Name	Description
`a`	`AttributesConfigName`
`b`	`AttributesConfigName`

Returns
Type	Description
`Boolean`