Retail v2 API - Class ControlName (2.8.0)

public sealed class ControlName : IResourceName, IEquatable<ControlName>

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

Resource name for the Control resource.

Inheritance

object > ControlName

Implements

IResourceName, IEquatable ControlName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ControlName(string, string, string, string)

public ControlName(string projectId, string locationId, string catalogId, string controlId)

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

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.
`controlId`	`string` The `Control` 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`

ControlId

public string ControlId { get; }

The Control 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 ControlName.ResourceNameType Type { get; }

The ControlName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ControlNameResourceNameType`

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

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

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

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.
`controlId`	`string` The `Control` ID. Must not be `null` or empty.

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

FormatProjectLocationCatalogControl(string, string, string, string)

public static string FormatProjectLocationCatalogControl(string projectId, string locationId, string catalogId, string controlId)

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

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.
`controlId`	`string` The `Control` ID. Must not be `null` or empty.

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

FromProjectLocationCatalogControl(string, string, string, string)

public static ControlName FromProjectLocationCatalogControl(string projectId, string locationId, string catalogId, string controlId)

Creates a ControlName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}.

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.
`controlId`	`string` The `Control` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ControlName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ControlName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static ControlName Parse(string controlName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string controlName, out ControlName result)

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

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

TryParse(string, bool, out ControlName)

public static bool TryParse(string controlName, bool allowUnparsed, out ControlName result)

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

Parameters
Name	Description
`controlName`	`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`	`ControlName` When this method returns, the parsed ControlName, 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}/controls/{control}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ControlName, ControlName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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