com.google.cloud.dialogflow.v2

Class Conversation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2.Conversation

All Implemented Interfaces:

ConversationOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Conversation.Builder Represents a conversation.
static class	Conversation.ConversationStage Enumeration of the different conversation stages a conversation can be in.
static class	Conversation.LifecycleState Enumeration of the completion status of the conversation.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONVERSATION_PROFILE_FIELD_NUMBER
static int	CONVERSATION_STAGE_FIELD_NUMBER
static int	END_TIME_FIELD_NUMBER
static int	LIFECYCLE_STATE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PHONE_NUMBER_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getConversationProfile() Required.
ByteString	getConversationProfileBytes() Required.
Conversation.ConversationStage	getConversationStage() The stage of a conversation.
int	getConversationStageValue() The stage of a conversation.
static Conversation	getDefaultInstance()
Conversation	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Parser<Conversation>	getParserForType()
ConversationPhoneNumber	getPhoneNumber() Output only.
ConversationPhoneNumberOrBuilder	getPhoneNumberOrBuilder() Output only.
int	getSerializedSize()
Timestamp	getStartTime() Output only.
TimestampOrBuilder	getStartTimeOrBuilder() Output only.
UnknownFieldSet	getUnknownFields()
boolean	hasEndTime() Output only.
int	hashCode()
boolean	hasPhoneNumber() Output only.
boolean	hasStartTime() Output only.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Conversation.Builder	newBuilder()
static Conversation.Builder	newBuilder(Conversation prototype)
Conversation.Builder	newBuilderForType()
protected Conversation.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Conversation	parseDelimitedFrom(InputStream input)
static Conversation	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Conversation	parseFrom(byte[] data)
static Conversation	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Conversation	parseFrom(ByteBuffer data)
static Conversation	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Conversation	parseFrom(ByteString data)
static Conversation	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Conversation	parseFrom(CodedInputStream input)
static Conversation	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Conversation	parseFrom(InputStream input)
static Conversation	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Conversation>	parser()
Conversation.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

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

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

CONVERSATION_STAGE_FIELD_NUMBER

public static final int CONVERSATION_STAGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class 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 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.v2.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.v2.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 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. 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];

Specified by:

hasPhoneNumber in interface ConversationOrBuilder

Returns:

Whether the phoneNumber field is set.

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

Specified by:

getPhoneNumber in interface ConversationOrBuilder

Returns:

The phoneNumber.

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

Specified by:

getPhoneNumberOrBuilder in interface ConversationOrBuilder

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

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

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

Specified by:

getConversationStage in interface ConversationOrBuilder

Returns:

The conversationStage.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Conversation parseFrom(ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Conversation parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Conversation parseFrom(InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Conversation parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Conversation parseDelimitedFrom(InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static Conversation parseFrom(CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Conversation parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public Conversation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Conversation.Builder newBuilder()

newBuilder

public static Conversation.Builder newBuilder(Conversation prototype)

toBuilder

public Conversation.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Conversation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Conversation getDefaultInstance()

parser

public static Parser<Conversation> parser()

getParserForType

public Parser<Conversation> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Conversation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder