public final class Conversation extends 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.v2.Conversation
Fields
CONVERSATION_PROFILE_FIELD_NUMBER
public static final int CONVERSATION_PROFILE_FIELD_NUMBER
Field Value
CONVERSATION_STAGE_FIELD_NUMBER
public static final int CONVERSATION_STAGE_FIELD_NUMBER
Field Value
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Field Value
LIFECYCLE_STATE_FIELD_NUMBER
public static final int LIFECYCLE_STATE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PHONE_NUMBER_FIELD_NUMBER
public static final int PHONE_NUMBER_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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) = { ... }
| Type | Description |
| String | The conversationProfile.
|
getConversationProfileBytes()
public 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) = { ... }
| Type | Description |
| ByteString | The bytes for conversationProfile.
|
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; Otherwise, defaults to
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, it skips
ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to
ConversationStage.HUMAN_ASSIST_STAGE.
.google.cloud.dialogflow.v2.Conversation.ConversationStage conversation_stage = 7;
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; Otherwise, defaults to
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, it skips
ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to
ConversationStage.HUMAN_ASSIST_STAGE.
.google.cloud.dialogflow.v2.Conversation.ConversationStage conversation_stage = 7;
| Type | Description |
| int | The enum numeric value on the wire for conversationStage.
|
getDefaultInstance()
public static Conversation getDefaultInstance()
Returns
getDefaultInstanceForType()
public Conversation getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getEndTime()
public Timestamp getEndTime()
Output only. The time the conversation was finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. The time the conversation was finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLifecycleState()
public 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];
getLifecycleStateValue()
public 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];
| Type | Description |
| int | The enum numeric value on the wire for lifecycleState.
|
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];
| Type | Description |
| String | The name.
|
getNameBytes()
public 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];
getParserForType()
public Parser<Conversation> getParserForType()
Returns
Overrides
getPhoneNumber()
public 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];
getPhoneNumberOrBuilder()
public 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStartTime()
public Timestamp getStartTime()
Output only. The time the conversation was started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. The time the conversation was started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasEndTime()
public boolean hasEndTime()
Output only. The time the conversation was finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the endTime field is set.
|
hasPhoneNumber()
public 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];
| Type | Description |
| boolean | Whether the phoneNumber field is set.
|
hasStartTime()
public boolean hasStartTime()
Output only. The time the conversation was started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Conversation.Builder newBuilder()
Returns
newBuilder(Conversation prototype)
public static Conversation.Builder newBuilder(Conversation prototype)
Parameter
Returns
newBuilderForType()
public Conversation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Conversation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Conversation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Conversation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Conversation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Conversation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Conversation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Conversation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Conversation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Conversation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Conversation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Conversation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Conversation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Conversation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Conversation> parser()
Returns
toBuilder()
public Conversation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
