com.google.cloud.dialogflow.v2

Interface ConversationOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Conversation, Conversation.Builder

public interface ConversationOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getConversationProfile() Required.
ByteString	getConversationProfileBytes() Required.
Conversation.ConversationStage	getConversationStage() The stage of a conversation.
int	getConversationStageValue() The stage of a conversation.
Timestamp	getEndTime() Output only.
TimestampOrBuilder	getEndTimeOrBuilder() Output only.
Conversation.LifecycleState	getLifecycleState() Output only.
int	getLifecycleStateValue() Output only.
String	getName() Output only.
ByteString	getNameBytes() Output only.
ConversationPhoneNumber	getPhoneNumber() Output only.
ConversationPhoneNumberOrBuilder	getPhoneNumberOrBuilder() Output only.
Timestamp	getStartTime() Output only.
TimestampOrBuilder	getStartTimeOrBuilder() Output only.
boolean	hasEndTime() Output only.
boolean	hasPhoneNumber() Output only.
boolean	hasStartTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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

Returns:

The name.

getNameBytes

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

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

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

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

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

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

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

 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;

Returns:

The enum numeric value on the wire for conversationStage.

getConversationStage

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

Returns:

The conversationStage.