Package com.google.cloud.dialogflow.v2

Interface ConversationOrBuilder

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

  • Method Details

    • getName

      String getName()
       Output only. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getLifecycleStateValue

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

    • getLifecycleState

      Conversation.LifecycleState getLifecycleState()
       Output only. The current state of the Conversation.
      .google.cloud.dialogflow.v2.Conversation.LifecycleState lifecycle_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The lifecycleState.

    • getConversationProfile

      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) = { ... }
      Returns:
      The conversationProfile.

    • getConversationProfileBytes

      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) = { ... }
      Returns:
      The bytes for conversationProfile.

    • hasPhoneNumber

      boolean hasPhoneNumber()
       Output only. It will not be empty if the conversation is to be connected
 over telephony.
      .google.cloud.dialogflow.v2.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the phoneNumber field is set.

    • getPhoneNumber

      ConversationPhoneNumber getPhoneNumber()
       Output only. It will not be empty if the conversation is to be connected
 over telephony.
      .google.cloud.dialogflow.v2.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The phoneNumber.

    • getPhoneNumberOrBuilder

      ConversationPhoneNumberOrBuilder getPhoneNumberOrBuilder()
       Output only. It will not be empty if the conversation is to be connected
 over telephony.
      .google.cloud.dialogflow.v2.ConversationPhoneNumber phone_number = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasStartTime

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

    • getStartTime

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

    • getStartTimeOrBuilder

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

    • hasEndTime

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

    • getEndTime

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

    • getEndTimeOrBuilder

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

    • getConversationStageValue

      int getConversationStageValue()
       Optional. 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.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE];
 Otherwise, defaults to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.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.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE],
 it skips
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]
 stage and directly goes to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].
      .google.cloud.dialogflow.v2.Conversation.ConversationStage conversation_stage = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for conversationStage.

    • getConversationStage

      Conversation.ConversationStage getConversationStage()
       Optional. 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.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE];
 Otherwise, defaults to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.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.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE],
 it skips
 [ConversationStage.VIRTUAL_AGENT_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.VIRTUAL_AGENT_STAGE]
 stage and directly goes to
 [ConversationStage.HUMAN_ASSIST_STAGE][google.cloud.dialogflow.v2.Conversation.ConversationStage.HUMAN_ASSIST_STAGE].
      .google.cloud.dialogflow.v2.Conversation.ConversationStage conversation_stage = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversationStage.

    • hasTelephonyConnectionInfo

      boolean hasTelephonyConnectionInfo()
       Output only. The telephony connection information.
      .google.cloud.dialogflow.v2.Conversation.TelephonyConnectionInfo telephony_connection_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the telephonyConnectionInfo field is set.

    • getTelephonyConnectionInfo

      Conversation.TelephonyConnectionInfo getTelephonyConnectionInfo()
       Output only. The telephony connection information.
      .google.cloud.dialogflow.v2.Conversation.TelephonyConnectionInfo telephony_connection_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The telephonyConnectionInfo.

    • getTelephonyConnectionInfoOrBuilder

      Conversation.TelephonyConnectionInfoOrBuilder getTelephonyConnectionInfoOrBuilder()
       Output only. The telephony connection information.
      .google.cloud.dialogflow.v2.Conversation.TelephonyConnectionInfo telephony_connection_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasInitialConversationProfile

      boolean hasInitialConversationProfile()
       Optional. Output only. The initial conversation profile to be used to
 configure this conversation, which is a copy of the conversation profile
 config read at conversation creation time.
      .google.cloud.dialogflow.v2.ConversationProfile initial_conversation_profile = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the initialConversationProfile field is set.

    • getInitialConversationProfile

      ConversationProfile getInitialConversationProfile()
       Optional. Output only. The initial conversation profile to be used to
 configure this conversation, which is a copy of the conversation profile
 config read at conversation creation time.
      .google.cloud.dialogflow.v2.ConversationProfile initial_conversation_profile = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The initialConversationProfile.

    • getInitialConversationProfileOrBuilder

      ConversationProfileOrBuilder getInitialConversationProfileOrBuilder()
       Optional. Output only. The initial conversation profile to be used to
 configure this conversation, which is a copy of the conversation profile
 config read at conversation creation time.
      .google.cloud.dialogflow.v2.ConversationProfile initial_conversation_profile = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

    • getIngestedContextReferencesCount

      int getIngestedContextReferencesCount()
       Output only. The context reference updates provided by external systems.
      map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsIngestedContextReferences

      boolean containsIngestedContextReferences(String key)
       Output only. The context reference updates provided by external systems.
      map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getIngestedContextReferences

      @Deprecated Map<String,Conversation.ContextReference> getIngestedContextReferences()
      Deprecated.
      Use getIngestedContextReferencesMap() instead.

    • getIngestedContextReferencesMap

      Map<String,Conversation.ContextReference> getIngestedContextReferencesMap()
       Output only. The context reference updates provided by external systems.
      map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getIngestedContextReferencesOrDefault

      Conversation.ContextReference getIngestedContextReferencesOrDefault(String key, Conversation.ContextReference defaultValue)
       Output only. The context reference updates provided by external systems.
      map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getIngestedContextReferencesOrThrow

      Conversation.ContextReference getIngestedContextReferencesOrThrow(String key)
       Output only. The context reference updates provided by external systems.
      map<string, .google.cloud.dialogflow.v2.Conversation.ContextReference> ingested_context_references = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInitialGeneratorContextsCount

      int getInitialGeneratorContextsCount()
       Output only. A map with generator name as key and generator context as
 value.
      map<string, .google.cloud.dialogflow.v2.Conversation.GeneratorContext> initial_generator_contexts = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsInitialGeneratorContexts

      boolean containsInitialGeneratorContexts(String key)
       Output only. A map with generator name as key and generator context as
 value.
      map<string, .google.cloud.dialogflow.v2.Conversation.GeneratorContext> initial_generator_contexts = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInitialGeneratorContexts

      @Deprecated Map<String,Conversation.GeneratorContext> getInitialGeneratorContexts()
      Deprecated.
      Use getInitialGeneratorContextsMap() instead.

    • getInitialGeneratorContextsMap

      Map<String,Conversation.GeneratorContext> getInitialGeneratorContextsMap()
       Output only. A map with generator name as key and generator context as
 value.
      map<string, .google.cloud.dialogflow.v2.Conversation.GeneratorContext> initial_generator_contexts = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInitialGeneratorContextsOrDefault

      Conversation.GeneratorContext getInitialGeneratorContextsOrDefault(String key, Conversation.GeneratorContext defaultValue)
       Output only. A map with generator name as key and generator context as
 value.
      map<string, .google.cloud.dialogflow.v2.Conversation.GeneratorContext> initial_generator_contexts = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInitialGeneratorContextsOrThrow

      Conversation.GeneratorContext getInitialGeneratorContextsOrThrow(String key)
       Output only. A map with generator name as key and generator context as
 value.
      map<string, .google.cloud.dialogflow.v2.Conversation.GeneratorContext> initial_generator_contexts = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];