Interface ConversationOrBuilder (0.1.0)

public interface ConversationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppVersion()

public abstract 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 abstract 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 abstract 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 abstract 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.

getDeployment()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract int getMessagesCount()

Deprecated. Use turns instead.

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

Returns
Type Description
int

getMessagesList() (deprecated)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSource()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.