Contact Center AI Insights v1 API - Class PhraseMatcherName (2.1.0)

public sealed class PhraseMatcherName : IResourceName, IEquatable<PhraseMatcherName>

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

Resource name for the PhraseMatcher resource.

Inheritance

Object > PhraseMatcherName

Implements

IResourceName, IEquatable<PhraseMatcherName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

PhraseMatcherName(String, String, String)

public PhraseMatcherName(string projectId, string locationId, string phraseMatcherId)

Constructs a new instance of a PhraseMatcherName class from the component parts of pattern projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

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.
`phraseMatcherId`	`String` The `PhraseMatcher` 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
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
`String`

PhraseMatcherId

public string PhraseMatcherId { get; }

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

The PhraseMatcherName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this PhraseMatcherName with pattern projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}.

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.
`phraseMatcherId`	`String` The `PhraseMatcher` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this PhraseMatcherName with pattern `projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}`.

FormatProjectLocationPhraseMatcher(String, String, String)

public static string FormatProjectLocationPhraseMatcher(string projectId, string locationId, string phraseMatcherId)

Formats the IDs into the string representation of this PhraseMatcherName with pattern projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}.

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.
`phraseMatcherId`	`String` The `PhraseMatcher` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this PhraseMatcherName with pattern `projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}`.

FromProjectLocationPhraseMatcher(String, String, String)

public static PhraseMatcherName FromProjectLocationPhraseMatcher(string projectId, string locationId, string phraseMatcherId)

Creates a PhraseMatcherName with the pattern projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}.

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.
`phraseMatcherId`	`String` The `PhraseMatcher` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static PhraseMatcherName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PhraseMatcherName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

Parse(String, Boolean)

public static PhraseMatcherName Parse(string phraseMatcherName, bool allowUnparsed)

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

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

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

Remarks

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

projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

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

public static bool TryParse(string phraseMatcherName, out PhraseMatcherName result)

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

Parameters
Name	Description
`phraseMatcherName`	`String` The resource name in string form. Must not be `null`.
`result`	`PhraseMatcherName` When this method returns, the parsed PhraseMatcherName, 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}/phraseMatchers/{phrase_matcher}

TryParse(String, Boolean, out PhraseMatcherName)

public static bool TryParse(string phraseMatcherName, bool allowUnparsed, out PhraseMatcherName result)

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

Parameters
Name	Description
`phraseMatcherName`	`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 ArgumentException if an unparseable resource name is specified.
`result`	`PhraseMatcherName` When this method returns, the parsed PhraseMatcherName, 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}/phraseMatchers/{phrase_matcher}

Or may be in any format if allowUnparsed is true.

Operators

Equality(PhraseMatcherName, PhraseMatcherName)

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

Parameters
Name	Description
`a`	`PhraseMatcherName`
`b`	`PhraseMatcherName`

Returns
Type	Description
`Boolean`

Inequality(PhraseMatcherName, PhraseMatcherName)

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

Parameters
Name	Description
`a`	`PhraseMatcherName`
`b`	`PhraseMatcherName`

Returns
Type	Description
`Boolean`