Class Conversation (0.1.0)

public final class Conversation extends GeneratedMessage implements ConversationOrBuilder

A conversation represents an interaction between an end user and the CES app.

Protobuf type google.cloud.ces.v1.Conversation

Static Fields

APP_VERSION_FIELD_NUMBER

public static final int APP_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CHANNEL_TYPE_FIELD_NUMBER

public static final int CHANNEL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYMENT_FIELD_NUMBER

public static final int DEPLOYMENT_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_AGENT_FIELD_NUMBER

public static final int ENTRY_AGENT_FIELD_NUMBER
Field Value
Type Description
int

INPUT_TYPES_FIELD_NUMBER

public static final int INPUT_TYPES_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGES_FIELD_NUMBER

public static final int MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TURNS_FIELD_NUMBER

public static final int TURNS_FIELD_NUMBER
Field Value
Type Description
int

TURN_COUNT_FIELD_NUMBER

public static final int TURN_COUNT_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

equals(Object obj)

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

getAppVersion()

public String getAppVersion()

Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The appVersion.

getAppVersionBytes()

public ByteString getAppVersionBytes()

Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for appVersion.

getChannelType() (deprecated)

public Conversation.ChannelType getChannelType()

Deprecated. google.cloud.ces.v1.Conversation.channel_type is deprecated. See google/cloud/ces/v1/conversation.proto;l=126

DEPRECATED. Please use input_types instead.

.google.cloud.ces.v1.Conversation.ChannelType channel_type = 8 [deprecated = true];

Returns
Type Description
Conversation.ChannelType

The channelType.

getChannelTypeValue() (deprecated)

public int getChannelTypeValue()

Deprecated. google.cloud.ces.v1.Conversation.channel_type is deprecated. See google/cloud/ces/v1/conversation.proto;l=126

DEPRECATED. Please use input_types instead.

.google.cloud.ces.v1.Conversation.ChannelType channel_type = 8 [deprecated = true];

Returns
Type Description
int

The enum numeric value on the wire for channelType.

getDefaultInstanceForType()

public Conversation getDefaultInstanceForType()
Returns
Type Description
Conversation

getDeployment()

public String getDeployment()

Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

string deployment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The deployment.

getDeploymentBytes()

public ByteString getDeploymentBytes()

Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

string deployment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for deployment.

getEndTime()

public Timestamp getEndTime()

Output only. Timestamp when the conversation was completed.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Timestamp when the conversation was completed.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getEntryAgent()

public String getEntryAgent()

Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string entry_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The entryAgent.

getEntryAgentBytes()

public ByteString getEntryAgentBytes()

Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string entry_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for entryAgent.

getInputTypes(int index)

public Conversation.InputType getInputTypes(int index)

Output only. The input types of the conversation.

repeated .google.cloud.ces.v1.Conversation.InputType input_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Conversation.InputType

The inputTypes at the given index.

getInputTypesCount()

public int getInputTypesCount()

Output only. The input types of the conversation.

repeated .google.cloud.ces.v1.Conversation.InputType input_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of inputTypes.

getInputTypesList()

public List<Conversation.InputType> getInputTypesList()

Output only. The input types of the conversation.

repeated .google.cloud.ces.v1.Conversation.InputType input_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<InputType>

A list containing the inputTypes.

getInputTypesValue(int index)

public int getInputTypesValue(int index)

Output only. The input types of the conversation.

repeated .google.cloud.ces.v1.Conversation.InputType input_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of inputTypes at the given index.

getInputTypesValueList()

public List<Integer> getInputTypesValueList()

Output only. The input types of the conversation.

repeated .google.cloud.ces.v1.Conversation.InputType input_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for inputTypes.

getLanguageCode()

public String getLanguageCode()

Output only. The language code of the conversation.

string language_code = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Output only. The language code of the conversation.

string language_code = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for languageCode.

getMessages(int index) (deprecated)

public Message getMessages(int index)

Deprecated. Use turns instead.

repeated .google.cloud.ces.v1.Message messages = 2 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
Message

getMessagesCount() (deprecated)

public int getMessagesCount()

Deprecated. Use turns instead.

repeated .google.cloud.ces.v1.Message messages = 2 [deprecated = true];

Returns
Type Description
int

getMessagesList() (deprecated)

public List<Message> getMessagesList()

Deprecated. Use turns instead.

repeated .google.cloud.ces.v1.Message messages = 2 [deprecated = true];

Returns
Type Description
List<Message>

getMessagesOrBuilder(int index) (deprecated)

public MessageOrBuilder getMessagesOrBuilder(int index)

Deprecated. Use turns instead.

repeated .google.cloud.ces.v1.Message messages = 2 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
MessageOrBuilder

getMessagesOrBuilderList() (deprecated)

public List<? extends MessageOrBuilder> getMessagesOrBuilderList()

Deprecated. Use turns instead.

repeated .google.cloud.ces.v1.Message messages = 2 [deprecated = true];

Returns
Type Description
List<? extends com.google.cloud.ces.v1.MessageOrBuilder>

getName()

public String getName()

Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSource()

public Conversation.Source getSource()

Output only. Indicate the source of the conversation.

.google.cloud.ces.v1.Conversation.Source source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Conversation.Source

The source.

getSourceValue()

public int getSourceValue()

Output only. Indicate the source of the conversation.

.google.cloud.ces.v1.Conversation.Source source = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for source.

getStartTime()

public Timestamp getStartTime()

Output only. Timestamp when the conversation was created.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Timestamp when the conversation was created.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getTurnCount()

public int getTurnCount()

Output only. The number of turns in the conversation.

int32 turn_count = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The turnCount.

getTurns(int index)

public Conversation.Turn getTurns(int index)

Required. The turns in the conversation.

repeated .google.cloud.ces.v1.Conversation.Turn turns = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Conversation.Turn

getTurnsCount()

public int getTurnsCount()

Required. The turns in the conversation.

repeated .google.cloud.ces.v1.Conversation.Turn turns = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getTurnsList()

public List<Conversation.Turn> getTurnsList()

Required. The turns in the conversation.

repeated .google.cloud.ces.v1.Conversation.Turn turns = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Turn>

getTurnsOrBuilder(int index)

public Conversation.TurnOrBuilder getTurnsOrBuilder(int index)

Required. The turns in the conversation.

repeated .google.cloud.ces.v1.Conversation.Turn turns = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Conversation.TurnOrBuilder

getTurnsOrBuilderList()

public List<? extends Conversation.TurnOrBuilder> getTurnsOrBuilderList()

Required. The turns in the conversation.

repeated .google.cloud.ces.v1.Conversation.Turn turns = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.ces.v1.Conversation.TurnOrBuilder>

hasEndTime()

public boolean hasEndTime()

Output only. Timestamp when the conversation was completed.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Timestamp when the conversation was created.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Conversation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Conversation.Builder
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