Retail v2 API - Class AttributesConfigName (2.15.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

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

The AttributesConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
AttributesConfigNameResourceNameType

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

Parse(string)

public static AttributesConfigName Parse(string attributesConfigName)

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

Parameter
Name Description
attributesConfigName 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, bool)

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

The string representation of the resource name.
Overrides

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 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
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}/attributesConfig

TryParse(string, bool, 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 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 AttributesConfigName

When this method returns, the parsed AttributesConfigName, 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}/attributesConfig
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttributesConfigName, AttributesConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AttributesConfigName

The first resource name to compare, or null.
b AttributesConfigName

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 !=(AttributesConfigName, AttributesConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AttributesConfigName

The first resource name to compare, or null.
b AttributesConfigName

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.