Interface ExampleOrBuilder (0.52.0)

Version latest

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface ExampleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActions(int index)

public abstract Action getActions(int index)

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Action

getActionsCount()

public abstract int getActionsCount()

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getActionsList()

public abstract List<Action> getActionsList()

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Action>

getActionsOrBuilder(int index)

public abstract ActionOrBuilder getActionsOrBuilder(int index)

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
ActionOrBuilder

getActionsOrBuilderList()

public abstract List<? extends ActionOrBuilder> getActionsOrBuilderList()

Required. The ordered list of actions performed by the end user and the Dialogflow agent.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];

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

getConversationState()

public abstract OutputState getConversationState()

Required. Example's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
OutputState	The conversationState.

getConversationStateValue()

public abstract int getConversationStateValue()

Required. Example's output state.

.google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for conversationState.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp of initial example creation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp of initial example creation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. The high level concise description of the example. The max number of characters is 200.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The high level concise description of the example. The max number of characters is 200.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the example.

string display_name = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the example.

string display_name = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getLanguageCode()

public abstract String getLanguageCode()

Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.

string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.

string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for languageCode.

getName()

public abstract String getName()

The unique identifier of the playbook example. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>/examples/<Example ID>.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the playbook example. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>/examples/<Example ID>.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getPlaybookInput()

public abstract PlaybookInput getPlaybookInput()

Optional. The input to the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PlaybookInput	The playbookInput.

getPlaybookInputOrBuilder()

public abstract PlaybookInputOrBuilder getPlaybookInputOrBuilder()

Optional. The input to the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PlaybookInputOrBuilder

getPlaybookOutput()

public abstract PlaybookOutput getPlaybookOutput()

Optional. The output of the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PlaybookOutput	The playbookOutput.

getPlaybookOutputOrBuilder()

public abstract PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()

Optional. The output of the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PlaybookOutputOrBuilder

getTokenCount()

public abstract long getTokenCount()

Output only. Estimated number of tokes current example takes when sent to the LLM.

int64 token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The tokenCount.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Last time the example was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last time the example was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp of initial example creation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasPlaybookInput()

public abstract boolean hasPlaybookInput()

Optional. The input to the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the playbookInput field is set.

hasPlaybookOutput()

public abstract boolean hasPlaybookOutput()

Optional. The output of the playbook in the example.

.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the playbookOutput field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Last time the example was updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.