Class Conversation (0.56.0)

public final class Conversation extends GeneratedMessageV3 implements ConversationOrBuilder

Represents a conversation.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Conversation

Static Fields

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

FLOWS_FIELD_NUMBER

public static final int FLOWS_FIELD_NUMBER
Field Value
Type Description
int

FLOW_VERSIONS_FIELD_NUMBER

public static final int FLOW_VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

INTENTS_FIELD_NUMBER

public static final int INTENTS_FIELD_NUMBER
Field Value
Type Description
int

INTERACTIONS_FIELD_NUMBER

public static final int INTERACTIONS_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PAGES_FIELD_NUMBER

public static final int PAGES_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Conversation getDefaultInstance()
Returns
Type Description
Conversation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Conversation.Builder newBuilder()
Returns
Type Description
Conversation.Builder

newBuilder(Conversation prototype)

public static Conversation.Builder newBuilder(Conversation prototype)
Parameter
Name Description
prototype Conversation
Returns
Type Description
Conversation.Builder

parseDelimitedFrom(InputStream input)

public static Conversation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Conversation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Conversation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Conversation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Conversation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Conversation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Conversation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Conversation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Conversation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Conversation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Conversation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Conversation> parser()
Returns
Type Description
Parser<Conversation>

Methods

containsFlowVersions(String key)

public boolean containsFlowVersions(String key)

Flow versions used in the conversation.

map<string, int64> flow_versions = 12;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Conversation getDefaultInstanceForType()
Returns
Type Description
Conversation

getDuration()

public Duration getDuration()

Duration of the conversation.

.google.protobuf.Duration duration = 5;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the conversation.

.google.protobuf.Duration duration = 5;

Returns
Type Description
DurationOrBuilder

getEnvironment()

public Environment getEnvironment()

Environment of the conversation. Only name and display_name are filled in this message.

.google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;

Returns
Type Description
Environment

The environment.

getEnvironmentOrBuilder()

public EnvironmentOrBuilder getEnvironmentOrBuilder()

Environment of the conversation. Only name and display_name are filled in this message.

.google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;

Returns
Type Description
EnvironmentOrBuilder

getFlowVersions() (deprecated)

public Map<String,Long> getFlowVersions()

Use #getFlowVersionsMap() instead.

Returns
Type Description
Map<String,java.lang.Long>

getFlowVersionsCount()

public int getFlowVersionsCount()

Flow versions used in the conversation.

map<string, int64> flow_versions = 12;

Returns
Type Description
int

getFlowVersionsMap()

public Map<String,Long> getFlowVersionsMap()

Flow versions used in the conversation.

map<string, int64> flow_versions = 12;

Returns
Type Description
Map<String,java.lang.Long>

getFlowVersionsOrDefault(String key, long defaultValue)

public long getFlowVersionsOrDefault(String key, long defaultValue)

Flow versions used in the conversation.

map<string, int64> flow_versions = 12;

Parameters
Name Description
key String
defaultValue long
Returns
Type Description
long

getFlowVersionsOrThrow(String key)

public long getFlowVersionsOrThrow(String key)

Flow versions used in the conversation.

map<string, int64> flow_versions = 12;

Parameter
Name Description
key String
Returns
Type Description
long

getFlows(int index)

public Flow getFlows(int index)

All the Flow the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;

Parameter
Name Description
index int
Returns
Type Description
Flow

getFlowsCount()

public int getFlowsCount()

All the Flow the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;

Returns
Type Description
int

getFlowsList()

public List<Flow> getFlowsList()

All the Flow the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;

Returns
Type Description
List<Flow>

getFlowsOrBuilder(int index)

public FlowOrBuilder getFlowsOrBuilder(int index)

All the Flow the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;

Parameter
Name Description
index int
Returns
Type Description
FlowOrBuilder

getFlowsOrBuilderList()

public List<? extends FlowOrBuilder> getFlowsOrBuilderList()

All the Flow the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Flow flows = 8;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.FlowOrBuilder>

getIntents(int index)

public Intent getIntents(int index)

All the matched Intent in the conversation. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;

Parameter
Name Description
index int
Returns
Type Description
Intent

getIntentsCount()

public int getIntentsCount()

All the matched Intent in the conversation. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;

Returns
Type Description
int

getIntentsList()

public List<Intent> getIntentsList()

All the matched Intent in the conversation. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;

Returns
Type Description
List<Intent>

getIntentsOrBuilder(int index)

public IntentOrBuilder getIntentsOrBuilder(int index)

All the matched Intent in the conversation. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;

Parameter
Name Description
index int
Returns
Type Description
IntentOrBuilder

getIntentsOrBuilderList()

public List<? extends IntentOrBuilder> getIntentsOrBuilderList()

All the matched Intent in the conversation. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent intents = 7;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.IntentOrBuilder>

getInteractions(int index)

public Conversation.Interaction getInteractions(int index)

Interactions of the conversation. Only populated for GetConversation and empty for ListConversations.

repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;

Parameter
Name Description
index int
Returns
Type Description
Conversation.Interaction

getInteractionsCount()

public int getInteractionsCount()

Interactions of the conversation. Only populated for GetConversation and empty for ListConversations.

repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;

Returns
Type Description
int

getInteractionsList()

public List<Conversation.Interaction> getInteractionsList()

Interactions of the conversation. Only populated for GetConversation and empty for ListConversations.

repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;

Returns
Type Description
List<Interaction>

getInteractionsOrBuilder(int index)

public Conversation.InteractionOrBuilder getInteractionsOrBuilder(int index)

Interactions of the conversation. Only populated for GetConversation and empty for ListConversations.

repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;

Parameter
Name Description
index int
Returns
Type Description
Conversation.InteractionOrBuilder

getInteractionsOrBuilderList()

public List<? extends Conversation.InteractionOrBuilder> getInteractionsOrBuilderList()

Interactions of the conversation. Only populated for GetConversation and empty for ListConversations.

repeated .google.cloud.dialogflow.cx.v3beta1.Conversation.Interaction interactions = 10;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Conversation.InteractionOrBuilder>

getLanguageCode()

public String getLanguageCode()

The language of the conversation, which is the language of the first request in the conversation.

string language_code = 3;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

The language of the conversation, which is the language of the first request in the conversation.

string language_code = 3;

Returns
Type Description
ByteString

The bytes for languageCode.

getMetrics()

public Conversation.Metrics getMetrics()

Conversation metrics.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;

Returns
Type Description
Conversation.Metrics

The metrics.

getMetricsOrBuilder()

public Conversation.MetricsOrBuilder getMetricsOrBuilder()

Conversation metrics.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;

Returns
Type Description
Conversation.MetricsOrBuilder

getName()

public String getName()

Identifier. The identifier of the conversation. If conversation ID is reused, interactions happened later than 48 hours of the conversation's create time will be ignored. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>/conversations/<Conversation ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The identifier of the conversation. If conversation ID is reused, interactions happened later than 48 hours of the conversation's create time will be ignored. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>/conversations/<Conversation ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPages(int index)

public Page getPages(int index)

All the Page the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;

Parameter
Name Description
index int
Returns
Type Description
Page

getPagesCount()

public int getPagesCount()

All the Page the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;

Returns
Type Description
int

getPagesList()

public List<Page> getPagesList()

All the Page the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;

Returns
Type Description
List<Page>

getPagesOrBuilder(int index)

public PageOrBuilder getPagesOrBuilder(int index)

All the Page the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;

Parameter
Name Description
index int
Returns
Type Description
PageOrBuilder

getPagesOrBuilderList()

public List<? extends PageOrBuilder> getPagesOrBuilderList()

All the Page the conversation has went through. Only name and display_name are filled in this message.

repeated .google.cloud.dialogflow.cx.v3beta1.Page pages = 9;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.PageOrBuilder>

getParserForType()

public Parser<Conversation> getParserForType()
Returns
Type Description
Parser<Conversation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Start time of the conversation, which is the time of the first request of the conversation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of the conversation, which is the time of the first request of the conversation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
TimestampOrBuilder

getType()

public Conversation.Type getType()

The type of the conversation.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Type type = 2;

Returns
Type Description
Conversation.Type

The type.

getTypeValue()

public int getTypeValue()

The type of the conversation.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Type type = 2;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasDuration()

public boolean hasDuration()

Duration of the conversation.

.google.protobuf.Duration duration = 5;

Returns
Type Description
boolean

Whether the duration field is set.

hasEnvironment()

public boolean hasEnvironment()

Environment of the conversation. Only name and display_name are filled in this message.

.google.cloud.dialogflow.cx.v3beta1.Environment environment = 11;

Returns
Type Description
boolean

Whether the environment field is set.

hasMetrics()

public boolean hasMetrics()

Conversation metrics.

.google.cloud.dialogflow.cx.v3beta1.Conversation.Metrics metrics = 6;

Returns
Type Description
boolean

Whether the metrics field is set.

hasStartTime()

public boolean hasStartTime()

Start time of the conversation, which is the time of the first request of the conversation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Conversation.Builder newBuilderForType()
Returns
Type Description
Conversation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Conversation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Conversation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Conversation.Builder toBuilder()
Returns
Type Description
Conversation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException