Contact Center AI Insights v1 API - Class AnalysisName (2.15.0)

public sealed class AnalysisName : IResourceName, IEquatable<AnalysisName>

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

Resource name for the Analysis resource.

Inheritance

object > AnalysisName

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

AnalysisName(string, string, string, string)

public AnalysisName(string projectId, string locationId, string conversationId, string analysisId)

Constructs a new instance of a AnalysisName class from the component parts of pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

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.
conversationId string

The Conversation ID. Must not be null or empty.
analysisId string

The Analysis ID. Must not be null or empty.

Properties

AnalysisId

public string AnalysisId { get; }

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

Property Value
Type Description
string

ConversationId

public string ConversationId { get; }

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

The AnalysisName.ResourceNameType of the contained resource name.

Property Value
Type Description
AnalysisNameResourceNameType

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

Formats the IDs into the string representation of this AnalysisName with pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

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.
conversationId string

The Conversation ID. Must not be null or empty.
analysisId string

The Analysis ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AnalysisName with pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

FormatProjectLocationConversationAnalysis(string, string, string, string)

public static string FormatProjectLocationConversationAnalysis(string projectId, string locationId, string conversationId, string analysisId)

Formats the IDs into the string representation of this AnalysisName with pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

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.
conversationId string

The Conversation ID. Must not be null or empty.
analysisId string

The Analysis ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AnalysisName with pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

FromProjectLocationConversationAnalysis(string, string, string, string)

public static AnalysisName FromProjectLocationConversationAnalysis(string projectId, string locationId, string conversationId, string analysisId)

Creates a AnalysisName with the pattern projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}.

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.
conversationId string

The Conversation ID. Must not be null or empty.
analysisId string

The Analysis ID. Must not be null or empty.
Returns
Type Description
AnalysisName

A new instance of AnalysisName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AnalysisName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnalysisName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AnalysisName

A new instance of AnalysisName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static AnalysisName Parse(string analysisName)

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

Parameter
Name Description
analysisName string

The resource name in string form. Must not be null.
Returns
Type Description
AnalysisName

The parsed AnalysisName if successful.
Remarks

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

  • projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

Parse(string, bool)

public static AnalysisName Parse(string analysisName, bool allowUnparsed)

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

Parameters
Name Description
analysisName 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
AnalysisName

The parsed AnalysisName if successful.
Remarks

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

  • projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
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

TryParse(string, out AnalysisName)

public static bool TryParse(string analysisName, out AnalysisName result)

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

Parameters
Name Description
analysisName string

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

When this method returns, the parsed AnalysisName, 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}/conversations/{conversation}/analyses/{analysis}

TryParse(string, bool, out AnalysisName)

public static bool TryParse(string analysisName, bool allowUnparsed, out AnalysisName result)

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

Parameters
Name Description
analysisName 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 AnalysisName

When this method returns, the parsed AnalysisName, 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}/conversations/{conversation}/analyses/{analysis}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnalysisName, AnalysisName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AnalysisName

The first resource name to compare, or null.
b AnalysisName

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 !=(AnalysisName, AnalysisName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AnalysisName

The first resource name to compare, or null.
b AnalysisName

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.