Interface ConversationOrBuilder (2.37.0)

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getAgentId()

public abstract String getAgentId()

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

string agent_id = 5;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for agentId.

getCallMetadata()

public abstract Conversation.CallMetadata getCallMetadata()

Call-specific metadata.

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

Returns
TypeDescription
Conversation.CallMetadata

The callMetadata.

getCallMetadataOrBuilder()

public abstract Conversation.CallMetadataOrBuilder getCallMetadataOrBuilder()

Call-specific metadata.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ConversationDataSourceOrBuilder

getDialogflowIntents() (deprecated)

public abstract Map<String,DialogflowIntent> getDialogflowIntents()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueDialogflowIntent
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getExpirationCase()

public abstract Conversation.ExpirationCase getExpirationCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getLanguageCode()

public abstract String getLanguageCode()

A user-specified language code for the conversation.

string language_code = 14;

Returns
TypeDescription
String

The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

A user-specified language code for the conversation.

string language_code = 14;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for medium.

getMetadataCase()

public abstract Conversation.MetadataCase getMetadataCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The obfuscatedUserId.

getObfuscatedUserIdBytes()

public abstract ByteString getObfuscatedUserIdBytes()

Obfuscated user ID which the customer sent to us.

string obfuscated_user_id = 21;

Returns
TypeDescription
ByteString

The bytes for obfuscatedUserId.

getQualityMetadata()

public abstract Conversation.QualityMetadata getQualityMetadata()

Conversation metadata related to quality management.

.google.cloud.contactcenterinsights.v1.Conversation.QualityMetadata quality_metadata = 24;

Returns
TypeDescription
Conversation.QualityMetadata

The qualityMetadata.

getQualityMetadataOrBuilder()

public abstract Conversation.QualityMetadataOrBuilder getQualityMetadataOrBuilder()

Conversation metadata related to quality management.

.google.cloud.contactcenterinsights.v1.Conversation.QualityMetadata quality_metadata = 24;

Returns
TypeDescription
Conversation.QualityMetadataOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

The time at which the conversation started.

.google.protobuf.Timestamp start_time = 17;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasCallMetadata()

public abstract boolean hasCallMetadata()

Call-specific metadata.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the latestSummary field is set.

hasQualityMetadata()

public abstract boolean hasQualityMetadata()

Conversation metadata related to quality management.

.google.cloud.contactcenterinsights.v1.Conversation.QualityMetadata quality_metadata = 24;

Returns
TypeDescription
boolean

Whether the qualityMetadata field is set.

hasStartTime()

public abstract boolean hasStartTime()

The time at which the conversation started.

.google.protobuf.Timestamp start_time = 17;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.