Package com.google.cloud.dialogflow.v2beta1

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
     Represents a conversation.
 A conversation is an interaction between an agent, including live agents
 and Dialogflow agents, and a support customer. Conversations can
 include phone calls and text-based chat sessions.
    Protobuf type google.cloud.dialogflow.v2beta1.Conversation
    See Also:
    Serialized Form

    • Field Detail

      • LIFECYCLE_STATE_FIELD_NUMBER

        public static final int LIFECYCLE_STATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSATION_PROFILE_FIELD_NUMBER

        public static final int CONVERSATION_PROFILE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHONE_NUMBER_FIELD_NUMBER

        public static final int PHONE_NUMBER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSATION_STAGE_FIELD_NUMBER

        public static final int CONVERSATION_STAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. The unique identifier of this conversation.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ConversationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The unique identifier of this conversation.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ConversationOrBuilder
        Returns:
        The bytes for name.

      • getLifecycleStateValue

        public int getLifecycleStateValue()
         Output only. The current state of the Conversation.
        .google.cloud.dialogflow.v2beta1.Conversation.LifecycleState lifecycle_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLifecycleStateValue in interface ConversationOrBuilder
        Returns:
        The enum numeric value on the wire for lifecycleState.

      • getLifecycleState

        public Conversation.LifecycleState getLifecycleState()
         Output only. The current state of the Conversation.
        .google.cloud.dialogflow.v2beta1.Conversation.LifecycleState lifecycle_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLifecycleState in interface ConversationOrBuilder
        Returns:
        The lifecycleState.

      • getConversationProfile

        public String getConversationProfile()
         Required. The Conversation Profile to be used to configure this
 Conversation. This field cannot be updated.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string conversation_profile = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversationProfile in interface ConversationOrBuilder
        Returns:
        The conversationProfile.

      • getConversationProfileBytes

        public com.google.protobuf.ByteString getConversationProfileBytes()
         Required. The Conversation Profile to be used to configure this
 Conversation. This field cannot be updated.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string conversation_profile = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversationProfileBytes in interface ConversationOrBuilder
        Returns:
        The bytes for conversationProfile.

      • hasPhoneNumber

        public boolean hasPhoneNumber()
         Output only. Required if the conversation is to be connected over
 telephony.
        .google.cloud.dialogflow.v2beta1.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPhoneNumber in interface ConversationOrBuilder
        Returns:
        Whether the phoneNumber field is set.

      • getPhoneNumber

        public ConversationPhoneNumber getPhoneNumber()
         Output only. Required if the conversation is to be connected over
 telephony.
        .google.cloud.dialogflow.v2beta1.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPhoneNumber in interface ConversationOrBuilder
        Returns:
        The phoneNumber.

      • getConversationStageValue

        public int getConversationStageValue()
         The stage of a conversation. It indicates whether the virtual agent or a
 human agent is handling the conversation.

 If the conversation is created with the conversation profile that has
 Dialogflow config set, defaults to
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE];
 Otherwise, defaults to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].

 If the conversation is created with the conversation profile that has
 Dialogflow config set but explicitly sets conversation_stage to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE],
 it skips
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]
 stage and directly goes to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].
        .google.cloud.dialogflow.v2beta1.Conversation.ConversationStage conversation_stage = 7;
        Specified by:
        getConversationStageValue in interface ConversationOrBuilder
        Returns:
        The enum numeric value on the wire for conversationStage.

      • getConversationStage

        public Conversation.ConversationStage getConversationStage()
         The stage of a conversation. It indicates whether the virtual agent or a
 human agent is handling the conversation.

 If the conversation is created with the conversation profile that has
 Dialogflow config set, defaults to
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE];
 Otherwise, defaults to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].

 If the conversation is created with the conversation profile that has
 Dialogflow config set but explicitly sets conversation_stage to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE],
 it skips
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]
 stage and directly goes to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2beta1.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].
        .google.cloud.dialogflow.v2beta1.Conversation.ConversationStage conversation_stage = 7;
        Specified by:
        getConversationStage in interface ConversationOrBuilder
        Returns:
        The conversationStage.

      • hasStartTime

        public boolean hasStartTime()
         Output only. The time the conversation was started.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface ConversationOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. The time the conversation was started.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface ConversationOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. The time the conversation was started.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface ConversationOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. The time the conversation was finished.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface ConversationOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. The time the conversation was finished.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface ConversationOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. The time the conversation was finished.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface ConversationOrBuilder

      • 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