Contact Center AI Insights v1 API - Class RecognizerName (2.13.0)

public sealed class RecognizerName : IResourceName, IEquatable<RecognizerName>

Reference documentation and code samples for the Contact Center AI Insights v1 API class RecognizerName.

Resource name for the Recognizer resource.

Inheritance

object > RecognizerName

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

RecognizerName(string, string, string)

public RecognizerName(string projectId, string locationId, string recognizerId)

Constructs a new instance of a RecognizerName class from the component parts of pattern projects/{project}/locations/{location}/recognizers/{recognizer}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

recognizerIdstring

The Recognizer ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

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

RecognizerId

public string RecognizerId { get; }

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

Property Value
TypeDescription
string

Type

public RecognizerName.ResourceNameType Type { get; }

The RecognizerName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RecognizerNameResourceNameType

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)

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

Formats the IDs into the string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

recognizerIdstring

The Recognizer ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

FormatProjectLocationRecognizer(string, string, string)

public static string FormatProjectLocationRecognizer(string projectId, string locationId, string recognizerId)

Formats the IDs into the string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

recognizerIdstring

The Recognizer ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RecognizerName with pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

FromProjectLocationRecognizer(string, string, string)

public static RecognizerName FromProjectLocationRecognizer(string projectId, string locationId, string recognizerId)

Creates a RecognizerName with the pattern projects/{project}/locations/{location}/recognizers/{recognizer}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

recognizerIdstring

The Recognizer ID. Must not be null or empty.

Returns
TypeDescription
RecognizerName

A new instance of RecognizerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RecognizerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RecognizerName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RecognizerName

A new instance of RecognizerName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static RecognizerName Parse(string recognizerName)

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

Parameter
NameDescription
recognizerNamestring

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

Returns
TypeDescription
RecognizerName

The parsed RecognizerName if successful.

Remarks

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

  • projects/{project}/locations/{location}/recognizers/{recognizer}

Parse(string, bool)

public static RecognizerName Parse(string recognizerName, bool allowUnparsed)

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

Parameters
NameDescription
recognizerNamestring

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

allowUnparsedbool

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
RecognizerName

The parsed RecognizerName if successful.

Remarks

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

  • projects/{project}/locations/{location}/recognizers/{recognizer}
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 RecognizerName)

public static bool TryParse(string recognizerName, out RecognizerName result)

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

Parameters
NameDescription
recognizerNamestring

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

resultRecognizerName

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

Returns
TypeDescription
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}/recognizers/{recognizer}

TryParse(string, bool, out RecognizerName)

public static bool TryParse(string recognizerName, bool allowUnparsed, out RecognizerName result)

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

Parameters
NameDescription
recognizerNamestring

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

allowUnparsedbool

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.

resultRecognizerName

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

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

Operators

operator ==(RecognizerName, RecognizerName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aRecognizerName

The first resource name to compare, or null.

bRecognizerName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(RecognizerName, RecognizerName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aRecognizerName

The first resource name to compare, or null.

bRecognizerName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.