Package com.google.cloud.contactcenterinsights.v1

Class Conversation

  • All Implemented Interfaces:
    ConversationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Conversation
extends com.google.protobuf.GeneratedMessageV3
implements ConversationOrBuilder
     The conversation resource.
    Protobuf type google.cloud.contactcenterinsights.v1.Conversation
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasCallMetadata

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

      • hasExpireTime

        public 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;
        Specified by:
        hasExpireTime in interface ConversationOrBuilder
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        public 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;
        Specified by:
        getExpireTime in interface ConversationOrBuilder
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        public 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;
        Specified by:
        getExpireTimeOrBuilder in interface ConversationOrBuilder

      • hasTtl

        public 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];
        Specified by:
        hasTtl in interface ConversationOrBuilder
        Returns:
        Whether the ttl field is set.

      • getTtl

        public 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];
        Specified by:
        getTtl in interface ConversationOrBuilder
        Returns:
        The ttl.

      • getTtlOrBuilder

        public 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];
        Specified by:
        getTtlOrBuilder in interface ConversationOrBuilder

      • getName

        public String getName()
         Immutable. The resource name of the conversation.
 Format:
 projects/{project}/locations/{location}/conversations/{conversation}
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface ConversationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ConversationOrBuilder
        Returns:
        The bytes for name.

      • hasDataSource

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

      • getDataSource

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

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which the conversation was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ConversationOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface ConversationOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface ConversationOrBuilder

      • hasUpdateTime

        public 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];
        Specified by:
        hasUpdateTime in interface ConversationOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface ConversationOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface ConversationOrBuilder

      • hasStartTime

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

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         The time at which the conversation started.
        .google.protobuf.Timestamp start_time = 17;
        Specified by:
        getStartTime in interface ConversationOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         The time at which the conversation started.
        .google.protobuf.Timestamp start_time = 17;
        Specified by:
        getStartTimeOrBuilder in interface ConversationOrBuilder

      • getLanguageCode

        public String getLanguageCode()
         A user-specified language code for the conversation.
        string language_code = 14;
        Specified by:
        getLanguageCode in interface ConversationOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

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

      • getAgentId

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

      • getAgentIdBytes

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

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ConversationOrBuilder
         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;
        Specified by:
        getLabelsCount in interface ConversationOrBuilder

      • containsLabels

        public 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;
        Specified by:
        containsLabels in interface ConversationOrBuilder

      • getLabelsMap

        public 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;
        Specified by:
        getLabelsMap in interface ConversationOrBuilder

      • getLabelsOrDefault

        public 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;
        Specified by:
        getLabelsOrDefault in interface ConversationOrBuilder

      • getLabelsOrThrow

        public 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;
        Specified by:
        getLabelsOrThrow in interface ConversationOrBuilder

      • hasTranscript

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

      • getTranscript

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

      • getMediumValue

        public 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];
        Specified by:
        getMediumValue in interface ConversationOrBuilder
        Returns:
        The enum numeric value on the wire for medium.

      • getMedium

        public 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];
        Specified by:
        getMedium in interface ConversationOrBuilder
        Returns:
        The medium.

      • hasDuration

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

      • getDuration

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

      • getDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Output only. The duration of the conversation.
        .google.protobuf.Duration duration = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDurationOrBuilder in interface ConversationOrBuilder

      • getTurnCount

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

      • hasLatestAnalysis

        public 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];
        Specified by:
        hasLatestAnalysis in interface ConversationOrBuilder
        Returns:
        Whether the latestAnalysis field is set.

      • getLatestAnalysis

        public 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];
        Specified by:
        getLatestAnalysis in interface ConversationOrBuilder
        Returns:
        The latestAnalysis.

      • getLatestAnalysisOrBuilder

        public 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];
        Specified by:
        getLatestAnalysisOrBuilder in interface ConversationOrBuilder

      • hasLatestSummary

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

      • getRuntimeAnnotationsList

        public 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];
        Specified by:
        getRuntimeAnnotationsList in interface ConversationOrBuilder

      • getRuntimeAnnotationsOrBuilderList

        public 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];
        Specified by:
        getRuntimeAnnotationsOrBuilderList in interface ConversationOrBuilder

      • getRuntimeAnnotationsCount

        public 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];
        Specified by:
        getRuntimeAnnotationsCount in interface ConversationOrBuilder

      • getRuntimeAnnotations

        public 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];
        Specified by:
        getRuntimeAnnotations in interface ConversationOrBuilder

      • getRuntimeAnnotationsOrBuilder

        public 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];
        Specified by:
        getRuntimeAnnotationsOrBuilder in interface ConversationOrBuilder

      • getDialogflowIntentsCount

        public int getDialogflowIntentsCount()
        Description copied from interface: ConversationOrBuilder
         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];
        Specified by:
        getDialogflowIntentsCount in interface ConversationOrBuilder

      • containsDialogflowIntents

        public 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];
        Specified by:
        containsDialogflowIntents in interface ConversationOrBuilder

      • getDialogflowIntentsMap

        public 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];
        Specified by:
        getDialogflowIntentsMap in interface ConversationOrBuilder

      • getDialogflowIntentsOrDefault

        public 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];
        Specified by:
        getDialogflowIntentsOrDefault in interface ConversationOrBuilder

      • getDialogflowIntentsOrThrow

        public 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];
        Specified by:
        getDialogflowIntentsOrThrow in interface ConversationOrBuilder

      • getObfuscatedUserId

        public String getObfuscatedUserId()
         Obfuscated user ID which the customer sent to us.
        string obfuscated_user_id = 21;
        Specified by:
        getObfuscatedUserId in interface ConversationOrBuilder
        Returns:
        The obfuscatedUserId.

      • getObfuscatedUserIdBytes

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Conversation parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Conversation parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Conversation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Conversation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Conversation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Conversation getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Conversation> parser()

      • getParserForType

        public com.google.protobuf.Parser<Conversation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Conversation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder