/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/contactcenterinsights/v1/resources.proto
package com.google.cloud.contactcenterinsights.v1;
public interface ConversationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contactcenterinsights.v1.Conversation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Call-specific metadata.
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;
*
*
* @return Whether the callMetadata field is set.
*/
boolean hasCallMetadata();
/**
*
*
*
* Call-specific metadata.
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;
*
*
* @return The callMetadata.
*/
com.google.cloud.contactcenterinsights.v1.Conversation.CallMetadata getCallMetadata();
/**
*
*
*
* Call-specific metadata.
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;
*
*/
com.google.cloud.contactcenterinsights.v1.Conversation.CallMetadataOrBuilder
getCallMetadataOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the expireTime field is set.
*/
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;
*
* @return The expireTime.
*/
com.google.protobuf.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;
*/
com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder();
/**
*
*
*
* 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];
*
* @return Whether the ttl field is set.
*/
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];
*
* @return The ttl.
*/
com.google.protobuf.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];
*/
com.google.protobuf.DurationOrBuilder getTtlOrBuilder();
/**
*
*
*
* Immutable. The resource name of the conversation.
* Format:
* projects/{project}/locations/{location}/conversations/{conversation}
*
*
* string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Immutable. The resource name of the conversation.
* Format:
* projects/{project}/locations/{location}/conversations/{conversation}
*
*
* string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The source of the audio and transcription for the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;
*
* @return Whether the dataSource field is set.
*/
boolean hasDataSource();
/**
*
*
*
* The source of the audio and transcription for the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;
*
* @return The dataSource.
*/
com.google.cloud.contactcenterinsights.v1.ConversationDataSource getDataSource();
/**
*
*
*
* The source of the audio and transcription for the conversation.
*
*
* .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;
*/
com.google.cloud.contactcenterinsights.v1.ConversationDataSourceOrBuilder
getDataSourceOrBuilder();
/**
*
*
*
* Output only. The time at which the conversation was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time at which the conversation was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time at which the conversation was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The most recent time at which the conversation was updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
com.google.protobuf.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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* The time at which the conversation started.
*
*
* .google.protobuf.Timestamp start_time = 17;
*
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*
*
* The time at which the conversation started.
*
*
* .google.protobuf.Timestamp start_time = 17;
*
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
*
*
* The time at which the conversation started.
*
*
* .google.protobuf.Timestamp start_time = 17;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* A user-specified language code for the conversation.
*
*
* string language_code = 14;
*
* @return The languageCode.
*/
java.lang.String getLanguageCode();
/**
*
*
*
* A user-specified language code for the conversation.
*
*
* string language_code = 14;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* An opaque, user-specified string representing the human agent who handled
* the conversation.
*
*
* string agent_id = 5;
*
* @return The agentId.
*/
java.lang.String getAgentId();
/**
*
*
*
* An opaque, user-specified string representing the human agent who handled
* the conversation.
*
*
* string agent_id = 5;
*
* @return The bytes for agentId.
*/
com.google.protobuf.ByteString getAgentIdBytes();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The conversation transcript.
*
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the transcript field is set.
*/
boolean hasTranscript();
/**
*
*
*
* Output only. The conversation transcript.
*
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The transcript.
*/
com.google.cloud.contactcenterinsights.v1.Conversation.Transcript getTranscript();
/**
*
*
*
* Output only. The conversation transcript.
*
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.contactcenterinsights.v1.Conversation.TranscriptOrBuilder
getTranscriptOrBuilder();
/**
*
*
*
* Immutable. The conversation medium, if unspecified will default to
* PHONE_CALL.
*
*
*
* .google.cloud.contactcenterinsights.v1.Conversation.Medium medium = 9 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The enum numeric value on the wire for medium.
*/
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];
*
*
* @return The medium.
*/
com.google.cloud.contactcenterinsights.v1.Conversation.Medium getMedium();
/**
*
*
*
* Output only. The duration of the conversation.
*
*
* .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
*
*
*
* Output only. The duration of the conversation.
*
*
* .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The duration.
*/
com.google.protobuf.Duration getDuration();
/**
*
*
*
* Output only. The duration of the conversation.
*
*
* .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.DurationOrBuilder getDurationOrBuilder();
/**
*
*
*
* Output only. The number of turns in the conversation.
*
*
* int32 turn_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The turnCount.
*/
int getTurnCount();
/**
*
*
*
* Output only. The conversation's latest analysis, if one exists.
*
*
*
* .google.cloud.contactcenterinsights.v1.Analysis latest_analysis = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the latestAnalysis field is set.
*/
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];
*
*
* @return The latestAnalysis.
*/
com.google.cloud.contactcenterinsights.v1.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];
*
*/
com.google.cloud.contactcenterinsights.v1.AnalysisOrBuilder getLatestAnalysisOrBuilder();
/**
*
*
*
* Output only. Latest summary of the conversation.
*
*
*
* .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the latestSummary field is set.
*/
boolean hasLatestSummary();
/**
*
*
*
* Output only. Latest summary of the conversation.
*
*
*
* .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The latestSummary.
*/
com.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData
getLatestSummary();
/**
*
*
*
* Output only. Latest summary of the conversation.
*
*
*
* .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionDataOrBuilder
getLatestSummaryOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.contactcenterinsights.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.contactcenterinsights.v1.RuntimeAnnotationOrBuilder
getRuntimeAnnotationsOrBuilder(int index);
/**
*
*
*
* 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];
*
*/
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];
*
*/
boolean containsDialogflowIntents(java.lang.String key);
/** Use {@link #getDialogflowIntentsMap()} instead. */
@java.lang.Deprecated
java.util.Map
getDialogflowIntents();
/**
*
*
*
* 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];
*
*/
java.util.Map
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];
*
*/
/* nullable */
com.google.cloud.contactcenterinsights.v1.DialogflowIntent getDialogflowIntentsOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.contactcenterinsights.v1.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];
*
*/
com.google.cloud.contactcenterinsights.v1.DialogflowIntent getDialogflowIntentsOrThrow(
java.lang.String key);
/**
*
*
*
* Obfuscated user ID which the customer sent to us.
*
*
* string obfuscated_user_id = 21;
*
* @return The obfuscatedUserId.
*/
java.lang.String getObfuscatedUserId();
/**
*
*
*
* Obfuscated user ID which the customer sent to us.
*
*
* string obfuscated_user_id = 21;
*
* @return The bytes for obfuscatedUserId.
*/
com.google.protobuf.ByteString getObfuscatedUserIdBytes();
public com.google.cloud.contactcenterinsights.v1.Conversation.MetadataCase getMetadataCase();
public com.google.cloud.contactcenterinsights.v1.Conversation.ExpirationCase getExpirationCase();
}