Package com.google.cloud.contactcenterinsights.v1

Interface ConversationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Conversation, Conversation.Builder
    public interface ConversationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasCallMetadata

        boolean hasCallMetadata()
         Call-specific metadata.
        .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;
        Returns:
        Whether the callMetadata field is set.

      • getCallMetadata

        Conversation.CallMetadata getCallMetadata()
         Call-specific metadata.
        .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;
        Returns:
        The callMetadata.

      • getCallMetadataOrBuilder

        Conversation.CallMetadataOrBuilder getCallMetadataOrBuilder()
         Call-specific metadata.
        .google.cloud.contactcenterinsights.v1.Conversation.CallMetadata call_metadata = 7;

      • hasExpireTime

        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:
        Whether the expireTime field is set.

      • getExpireTime

        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;
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        com.google.protobuf.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;

      • hasTtl

        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:
        Whether the ttl field is set.

      • getTtl

        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];
        Returns:
        The ttl.

      • getTtlOrBuilder

        com.google.protobuf.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];

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • hasDataSource

        boolean hasDataSource()
         The source of the audio and transcription for the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;
        Returns:
        Whether the dataSource field is set.

      • getDataSource

        ConversationDataSource getDataSource()
         The source of the audio and transcription for the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;
        Returns:
        The dataSource.

      • getDataSourceOrBuilder

        ConversationDataSourceOrBuilder getDataSourceOrBuilder()
         The source of the audio and transcription for the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationDataSource data_source = 2;

      • hasCreateTime

        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:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which the conversation was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.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];

      • hasStartTime

        boolean hasStartTime()
         The time at which the conversation started.
        .google.protobuf.Timestamp start_time = 17;
        Returns:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.Timestamp getStartTime()
         The time at which the conversation started.
        .google.protobuf.Timestamp start_time = 17;
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         The time at which the conversation started.
        .google.protobuf.Timestamp start_time = 17;

      • getLanguageCode

        String getLanguageCode()
         A user-specified language code for the conversation.
        string language_code = 14;
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         A user-specified language code for the conversation.
        string language_code = 14;
        Returns:
        The bytes for languageCode.

      • getAgentId

        String getAgentId()
         An opaque, user-specified string representing the human agent who handled
 the conversation.
        string agent_id = 5;
        Returns:
        The agentId.

      • getAgentIdBytes

        com.google.protobuf.ByteString getAgentIdBytes()
         An opaque, user-specified string representing the human agent who handled
 the conversation.
        string agent_id = 5;
        Returns:
        The bytes for agentId.

      • getLabelsCount

        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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • hasTranscript

        boolean hasTranscript()
         Output only. The conversation transcript.
        .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the transcript field is set.

      • getTranscript

        Conversation.Transcript getTranscript()
         Output only. The conversation transcript.
        .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The transcript.

      • getTranscriptOrBuilder

        Conversation.TranscriptOrBuilder getTranscriptOrBuilder()
         Output only. The conversation transcript.
        .google.cloud.contactcenterinsights.v1.Conversation.Transcript transcript = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMediumValue

        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:
        The enum numeric value on the wire for medium.

      • getMedium

        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:
        The medium.

      • hasDuration

        boolean hasDuration()
         Output only. The duration of the conversation.
        .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the duration field is set.

      • getDuration

        com.google.protobuf.Duration getDuration()
         Output only. The duration of the conversation.
        .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The duration.

      • getDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Output only. The duration of the conversation.
        .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTurnCount

        int getTurnCount()
         Output only. The number of turns in the conversation.
        int32 turn_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The turnCount.

      • hasLatestAnalysis

        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:
        Whether the latestAnalysis field is set.

      • getLatestAnalysis

        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:
        The latestAnalysis.

      • getLatestAnalysisOrBuilder

        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];

      • hasLatestSummary

        boolean hasLatestSummary()
         Output only. Latest summary of the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the latestSummary field is set.

      • getLatestSummary

        ConversationSummarizationSuggestionData getLatestSummary()
         Output only. Latest summary of the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The latestSummary.

      • getLatestSummaryOrBuilder

        ConversationSummarizationSuggestionDataOrBuilder getLatestSummaryOrBuilder()
         Output only. Latest summary of the conversation.
        .google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData latest_summary = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getRuntimeAnnotationsList

        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];

      • getRuntimeAnnotations

        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];

      • getRuntimeAnnotationsCount

        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];

      • getRuntimeAnnotationsOrBuilderList

        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];

      • getRuntimeAnnotationsOrBuilder

        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];

      • getDialogflowIntentsCount

        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];

      • containsDialogflowIntents

        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];

      • getDialogflowIntentsMap

        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];

      • getDialogflowIntentsOrDefault

        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];

      • getDialogflowIntentsOrThrow

        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];

      • getObfuscatedUserId

        String getObfuscatedUserId()
         Obfuscated user ID which the customer sent to us.
        string obfuscated_user_id = 21;
        Returns:
        The obfuscatedUserId.

      • getObfuscatedUserIdBytes

        com.google.protobuf.ByteString getObfuscatedUserIdBytes()
         Obfuscated user ID which the customer sent to us.
        string obfuscated_user_id = 21;
        Returns:
        The bytes for obfuscatedUserId.