Interface ConversationOrBuilder (2.23.0)

Version 2.23.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.7

public interface ConversationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDialogflowIntents(String key)

public abstract boolean containsDialogflowIntents(String key)

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

map<string, .google.cloud.contactcenterinsights.v1.DialogflowIntent> dialogflow_intents = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAgentId()

public abstract String getAgentId()

An opaque, user-specified string representing the human agent who handled the conversation.

string agent_id = 5;

Returns
Type	Description
String	The agentId.

getAgentIdBytes()

public abstract ByteString getAgentIdBytes()

An opaque, user-specified string representing the human agent who handled the conversation.

string agent_id = 5;

Returns
Type	Description
ByteString	The bytes for agentId.

getCallMetadata()

public abstract Conversation.CallMetadata getCallMetadata()

Call-specific metadata.

.google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;

Returns
Type	Description
Conversation.CallMetadata	The callMetadata.

getCallMetadataOrBuilder()

public abstract Conversation.CallMetadataOrBuilder getCallMetadataOrBuilder()

Call-specific metadata.

.google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;

Returns
Type	Description
Conversation.CallMetadataOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which the conversation was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the conversation was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDataSource()

public abstract ConversationDataSource getDataSource()

The source of the audio and transcription for the conversation.

.google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;

Returns
Type	Description
ConversationDataSource	The dataSource.

getDataSourceOrBuilder()

public abstract ConversationDataSourceOrBuilder getDataSourceOrBuilder()

The source of the audio and transcription for the conversation.

.google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;

Returns
Type	Description
ConversationDataSourceOrBuilder

getDialogflowIntents()

public abstract Map<String,DialogflowIntent> getDialogflowIntents()

Use #getDialogflowIntentsMap() instead.

Returns
Type	Description
Map<String,DialogflowIntent>

getDialogflowIntentsCount()

public abstract int getDialogflowIntentsCount()

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

map<string, .google.cloud.contactcenterinsights.v1.DialogflowIntent> dialogflow_intents = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getDialogflowIntentsMap()

public abstract Map<String,DialogflowIntent> getDialogflowIntentsMap()

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

map<string, .google.cloud.contactcenterinsights.v1.DialogflowIntent> dialogflow_intents = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<String,DialogflowIntent>

getDialogflowIntentsOrDefault(String key, DialogflowIntent defaultValue)

public abstract DialogflowIntent getDialogflowIntentsOrDefault(String key, DialogflowIntent defaultValue)

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

map<string, .google.cloud.contactcenterinsights.v1.DialogflowIntent> dialogflow_intents = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	String
defaultValue	DialogflowIntent

Returns
Type	Description
DialogflowIntent

getDialogflowIntentsOrThrow(String key)

public abstract DialogflowIntent getDialogflowIntentsOrThrow(String key)

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

map<string, .google.cloud.contactcenterinsights.v1.DialogflowIntent> dialogflow_intents = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	String

Returns
Type	Description
DialogflowIntent

getDuration()

public abstract Duration getDuration()

Output only. The duration of the conversation.

.google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Duration	The duration.

getDurationOrBuilder()

public abstract DurationOrBuilder getDurationOrBuilder()

Output only. The duration of the conversation.

.google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getExpirationCase()

public abstract Conversation.ExpirationCase getExpirationCase()

Returns
Type	Description
Conversation.ExpirationCase

getExpireTime()

public abstract Timestamp getExpireTime()

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.

.google.protobuf.Timestamp expire_time = 15;

Returns
Type	Description
Timestamp	The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.

.google.protobuf.Timestamp expire_time = 15;

Returns
Type	Description
TimestampOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

map<string, string> labels = 6;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

map<string, string> labels = 6;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

map<string, string> labels = 6;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLanguageCode()

public abstract String getLanguageCode()

A user-specified language code for the conversation.

string language_code = 14;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

A user-specified language code for the conversation.

string language_code = 14;

Returns
Type	Description
ByteString	The bytes for languageCode.

getLatestAnalysis()

public abstract Analysis getLatestAnalysis()

Output only. The conversation's latest analysis, if one exists.

.google.cloud.contactcenterinsights.v1.Analysis latest_analysis = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Analysis	The latestAnalysis.

getLatestAnalysisOrBuilder()

public abstract AnalysisOrBuilder getLatestAnalysisOrBuilder()

Output only. The conversation's latest analysis, if one exists.

.google.cloud.contactcenterinsights.v1.Analysis latest_analysis = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AnalysisOrBuilder

getLatestSummary()

public abstract ConversationSummarizationSuggestionData getLatestSummary()

Output only. Latest summary of the conversation.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ConversationSummarizationSuggestionData	The latestSummary.

getLatestSummaryOrBuilder()

public abstract ConversationSummarizationSuggestionDataOrBuilder getLatestSummaryOrBuilder()

Output only. Latest summary of the conversation.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ConversationSummarizationSuggestionDataOrBuilder

getMedium()

public abstract Conversation.Medium getMedium()

Immutable. The conversation medium, if unspecified will default to PHONE_CALL.

.google.cloud.contactcenterinsights.v1.Conversation.Medium medium = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
Conversation.Medium	The medium.

getMediumValue()

public abstract int getMediumValue()

Immutable. The conversation medium, if unspecified will default to PHONE_CALL.

.google.cloud.contactcenterinsights.v1.Conversation.Medium medium = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for medium.

getMetadataCase()

public abstract Conversation.MetadataCase getMetadataCase()

Returns
Type	Description
Conversation.MetadataCase

getName()

public abstract String getName()

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getObfuscatedUserId()

public abstract String getObfuscatedUserId()

Obfuscated user ID which the customer sent to us.

string obfuscated_user_id = 21;

Returns
Type	Description
String	The obfuscatedUserId.

getObfuscatedUserIdBytes()

public abstract ByteString getObfuscatedUserIdBytes()

Obfuscated user ID which the customer sent to us.

string obfuscated_user_id = 21;

Returns
Type	Description
ByteString	The bytes for obfuscatedUserId.

getRuntimeAnnotations(int index)

public abstract RuntimeAnnotation getRuntimeAnnotations(int index)

Output only. The annotations that were generated during the customer and agent interaction.

repeated .google.cloud.contactcenterinsights.v1.RuntimeAnnotation runtime_annotations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
RuntimeAnnotation

getRuntimeAnnotationsCount()

public abstract int getRuntimeAnnotationsCount()

Output only. The annotations that were generated during the customer and agent interaction.

repeated .google.cloud.contactcenterinsights.v1.RuntimeAnnotation runtime_annotations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getRuntimeAnnotationsList()

public abstract List<RuntimeAnnotation> getRuntimeAnnotationsList()

Output only. The annotations that were generated during the customer and agent interaction.

repeated .google.cloud.contactcenterinsights.v1.RuntimeAnnotation runtime_annotations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<RuntimeAnnotation>

getRuntimeAnnotationsOrBuilder(int index)

public abstract RuntimeAnnotationOrBuilder getRuntimeAnnotationsOrBuilder(int index)

Output only. The annotations that were generated during the customer and agent interaction.

repeated .google.cloud.contactcenterinsights.v1.RuntimeAnnotation runtime_annotations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
RuntimeAnnotationOrBuilder

getRuntimeAnnotationsOrBuilderList()

public abstract List<? extends RuntimeAnnotationOrBuilder> getRuntimeAnnotationsOrBuilderList()

Output only. The annotations that were generated during the customer and agent interaction.

repeated .google.cloud.contactcenterinsights.v1.RuntimeAnnotation runtime_annotations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.contactcenterinsights.v1.RuntimeAnnotationOrBuilder>

getStartTime()

public abstract Timestamp getStartTime()

The time at which the conversation started.

.google.protobuf.Timestamp start_time = 17;

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

The time at which the conversation started.

.google.protobuf.Timestamp start_time = 17;

Returns
Type	Description
TimestampOrBuilder

getTranscript()

public abstract Conversation.Transcript getTranscript()

Output only. The conversation transcript.

.google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Conversation.Transcript	The transcript.

getTranscriptOrBuilder()

public abstract Conversation.TranscriptOrBuilder getTranscriptOrBuilder()

Output only. The conversation transcript.

.google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Conversation.TranscriptOrBuilder

getTtl()

public abstract Duration getTtl()

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.

.google.protobuf.Duration ttl = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Duration	The ttl.

getTtlOrBuilder()

public abstract DurationOrBuilder getTtlOrBuilder()

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.

.google.protobuf.Duration ttl = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getTurnCount()

public abstract int getTurnCount()

Output only. The number of turns in the conversation.

int32 turn_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The turnCount.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The most recent time at which the conversation was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The most recent time at which the conversation was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCallMetadata()

public abstract boolean hasCallMetadata()

Call-specific metadata.

.google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;

Returns
Type	Description
boolean	Whether the callMetadata field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which the conversation was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDataSource()

public abstract boolean hasDataSource()

The source of the audio and transcription for the conversation.

.google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;

Returns
Type	Description
boolean	Whether the dataSource field is set.

hasDuration()

public abstract boolean hasDuration()

Output only. The duration of the conversation.

.google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the duration field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.

.google.protobuf.Timestamp expire_time = 15;

Returns
Type	Description
boolean	Whether the expireTime field is set.

hasLatestAnalysis()

public abstract boolean hasLatestAnalysis()

Output only. The conversation's latest analysis, if one exists.

.google.cloud.contactcenterinsights.v1.Analysis latest_analysis = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the latestAnalysis field is set.

hasLatestSummary()

public abstract boolean hasLatestSummary()

Output only. Latest summary of the conversation.

.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the latestSummary field is set.

hasStartTime()

public abstract boolean hasStartTime()

The time at which the conversation started.

.google.protobuf.Timestamp start_time = 17;

Returns
Type	Description
boolean	Whether the startTime field is set.

hasTranscript()

public abstract boolean hasTranscript()

Output only. The conversation transcript.

.google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the transcript field is set.

hasTtl()

public abstract boolean hasTtl()

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.

.google.protobuf.Duration ttl = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	Whether the ttl field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The most recent time at which the conversation was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.