Class ControlName (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ControlName : IResourceName, IEquatable<ControlName>

Resource name for the Control resource.

Inheritance

Object > ControlName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

controlIdString

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
TypeDescription
String

ControlId

public string ControlId { get; }

The Control ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

Type

public ControlName.ResourceNameType Type { get; }

The ControlName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ControlName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

controlIdString

The Control ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

controlIdString

The Control ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

controlIdString

The Control ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ControlName

A new instance of ControlName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ControlName Parse(string controlName)

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

Parameter
NameDescription
controlNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
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, Boolean)

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
NameDescription
controlNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
controlNameString

The resource name in string form. Must not be null.

resultControlName

When this method returns, the parsed ControlName, or null if parsing failed.

Returns
TypeDescription
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}/controls/{control}

TryParse(String, Boolean, 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
NameDescription
controlNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultControlName

When this method returns, the parsed ControlName, or null if parsing failed.

Returns
TypeDescription
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}/controls/{control}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ControlName, ControlName)

public static bool operator ==(ControlName a, ControlName b)
Parameters
NameDescription
aControlName
bControlName
Returns
TypeDescription
Boolean

Inequality(ControlName, ControlName)

public static bool operator !=(ControlName a, ControlName b)
Parameters
NameDescription
aControlName
bControlName
Returns
TypeDescription
Boolean