Contact Center AI Insights v1 API - Class ConversationName (2.5.0)

public sealed class ConversationName : IResourceName, IEquatable<ConversationName>

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

Resource name for the Conversation resource.

Inheritance

object > ConversationName

Namespace

GoogleCloudGoogle.Cloud.ContactCenterInsightsV1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

ConversationName(string, string, string)

public ConversationName(string projectId, string locationId, string conversationId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversationIdstring

The Conversation ID. Must not be null or empty.

Properties

ConversationId

public string ConversationId { get; }

The Conversation 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
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

Type

public ConversationName.ResourceNameType Type { get; }

The ConversationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConversationNameResourceNameType

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

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversationIdstring

The Conversation ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationConversation(string, string, string)

public static string FormatProjectLocationConversation(string projectId, string locationId, string conversationId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversationIdstring

The Conversation ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationConversation(string, string, string)

public static ConversationName FromProjectLocationConversation(string projectId, string locationId, string conversationId)

Creates a ConversationName with the pattern projects/{project}/locations/{location}/conversations/{conversation}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversationIdstring

The Conversation ID. Must not be null or empty.

Returns
TypeDescription
ConversationName

A new instance of ConversationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConversationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversationName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConversationName

A new instance of ConversationName 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 ConversationName Parse(string conversationName)

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

Parameter
NameDescription
conversationNamestring

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

Returns
TypeDescription
ConversationName

The parsed ConversationName if successful.

Remarks

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

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

Parse(string, bool)

public static ConversationName Parse(string conversationName, bool allowUnparsed)

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

Parameters
NameDescription
conversationNamestring

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
ConversationName

The parsed ConversationName if successful.

Remarks

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

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

public static bool TryParse(string conversationName, out ConversationName result)

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

Parameters
NameDescription
conversationNamestring

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

resultConversationName

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

TryParse(string, bool, out ConversationName)

public static bool TryParse(string conversationName, bool allowUnparsed, out ConversationName result)

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

Parameters
NameDescription
conversationNamestring

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.

resultConversationName

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

Operators

operator ==(ConversationName, ConversationName)

public static bool operator ==(ConversationName a, ConversationName b)
Parameters
NameDescription
aConversationName
bConversationName
Returns
TypeDescription
bool

operator !=(ConversationName, ConversationName)

public static bool operator !=(ConversationName a, ConversationName b)
Parameters
NameDescription
aConversationName
bConversationName
Returns
TypeDescription
bool