Contact Center AI Insights v1 API - Class AnalysisRuleName (2.18.0)

public sealed class AnalysisRuleName : IResourceName, IEquatable<AnalysisRuleName>

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

Resource name for the AnalysisRule resource.

Inheritance

object > AnalysisRuleName

Implements

IResourceName, IEquatable AnalysisRuleName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

AnalysisRuleName(string, string, string)

public AnalysisRuleName(string projectId, string locationId, string analysisRuleId)

Constructs a new instance of a AnalysisRuleName class from the component parts of pattern projects/{project}/locations/{location}/analysisRules/{analysis_rule}

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

Properties

AnalysisRuleId

public string AnalysisRuleId { get; }

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

The AnalysisRuleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AnalysisRuleNameResourceNameType`

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

Formats the IDs into the string representation of this AnalysisRuleName with pattern projects/{project}/locations/{location}/analysisRules/{analysis_rule}.

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

Returns
Type	Description
`string`	The string representation of this AnalysisRuleName with pattern `projects/{project}/locations/{location}/analysisRules/{analysis_rule}`.

FormatProjectLocationAnalysisRule(string, string, string)

public static string FormatProjectLocationAnalysisRule(string projectId, string locationId, string analysisRuleId)

Formats the IDs into the string representation of this AnalysisRuleName with pattern projects/{project}/locations/{location}/analysisRules/{analysis_rule}.

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

Returns
Type	Description
`string`	The string representation of this AnalysisRuleName with pattern `projects/{project}/locations/{location}/analysisRules/{analysis_rule}`.

FromProjectLocationAnalysisRule(string, string, string)

public static AnalysisRuleName FromProjectLocationAnalysisRule(string projectId, string locationId, string analysisRuleId)

Creates a AnalysisRuleName with the pattern projects/{project}/locations/{location}/analysisRules/{analysis_rule}.

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

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

FromUnparsed(UnparsedResourceName)

public static AnalysisRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnalysisRuleName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/analysisRules/{analysis_rule}

Parse(string, bool)

public static AnalysisRuleName Parse(string analysisRuleName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/analysisRules/{analysis_rule}

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

public static bool TryParse(string analysisRuleName, out AnalysisRuleName result)

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

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

TryParse(string, bool, out AnalysisRuleName)

public static bool TryParse(string analysisRuleName, bool allowUnparsed, out AnalysisRuleName result)

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

Parameters
Name	Description
`analysisRuleName`	`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`	`AnalysisRuleName` When this method returns, the parsed AnalysisRuleName, 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}/analysisRules/{analysis_rule}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnalysisRuleName, AnalysisRuleName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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