Class Example.Builder (0.52.0)

public static final class Example.Builder extends GeneratedMessageV3.Builder<Example.Builder> implements ExampleOrBuilder

Example represents a sample execution of the playbook in the conversation.

An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Example.Builder

Implements

ExampleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addActions(Action value)

public Example.Builder addActions(Action value)

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
`value`	`Action`

Returns
Type	Description
`Example.Builder`

addActions(Action.Builder builderForValue)

public Example.Builder addActions(Action.Builder builderForValue)

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
`builderForValue`	`Action.Builder`

Returns
Type	Description
`Example.Builder`

addActions(int index, Action value)

public Example.Builder addActions(int index, Action value)

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

Parameters
Name	Description
`index`	`int`
`value`	`Action`

Returns
Type	Description
`Example.Builder`

addActions(int index, Action.Builder builderForValue)

public Example.Builder addActions(int index, Action.Builder builderForValue)

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Action.Builder`

Returns
Type	Description
`Example.Builder`

addActionsBuilder()

public Action.Builder addActionsBuilder()

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
`Action.Builder`

addActionsBuilder(int index)

public Action.Builder addActionsBuilder(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.Builder`

addAllActions(Iterable<? extends Action> values)

public Example.Builder addAllActions(Iterable<? extends Action> values)

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
`values`	`Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.Action>`

Returns
Type	Description
`Example.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Example build()

Returns
Type	Description
`Example`

buildPartial()

public Example buildPartial()

Returns
Type	Description
`Example`

clear()

public Example.Builder clear()

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearActions()

public Example.Builder clearActions()

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
`Example.Builder`

clearConversationState()

public Example.Builder clearConversationState()

Required. Example's output state.

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

Returns
Type	Description
`Example.Builder`	This builder for chaining.

clearCreateTime()

public Example.Builder clearCreateTime()

Output only. The timestamp of initial example creation.

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

Returns
Type	Description
`Example.Builder`

clearDescription()

public Example.Builder clearDescription()

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
`Example.Builder`	This builder for chaining.

clearDisplayName()

public Example.Builder clearDisplayName()

Required. The display name of the example.

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

Returns
Type	Description
`Example.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Example.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLanguageCode()

public Example.Builder clearLanguageCode()

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
`Example.Builder`	This builder for chaining.

clearName()

public Example.Builder clearName()

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
`Example.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Example.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPlaybookInput()

public Example.Builder clearPlaybookInput()

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
`Example.Builder`

clearPlaybookOutput()

public Example.Builder clearPlaybookOutput()

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
`Example.Builder`

clearTokenCount()

public Example.Builder clearTokenCount()

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
`Example.Builder`	This builder for chaining.

clearUpdateTime()

public Example.Builder clearUpdateTime()

Output only. Last time the example was updated.

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

Returns
Type	Description
`Example.Builder`

clone()

public Example.Builder clone()

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getActions(int index)

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

getActionsBuilder(int index)

public Action.Builder getActionsBuilder(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.Builder`

getActionsBuilderList()

public List<Action.Builder> getActionsBuilderList()

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

getActionsCount()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp of initial example creation.

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

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

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

getDefaultInstanceForType()

public Example getDefaultInstanceForType()

Returns
Type	Description
`Example`

getDescription()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

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

getPlaybookInputBuilder()

public PlaybookInput.Builder getPlaybookInputBuilder()

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.Builder`

getPlaybookInputOrBuilder()

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

getPlaybookOutputBuilder()

public PlaybookOutput.Builder getPlaybookOutputBuilder()

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.Builder`

getPlaybookOutputOrBuilder()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Last time the example was updated.

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

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Example.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp of initial example creation.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Example.Builder`

mergeFrom(Example other)

public Example.Builder mergeFrom(Example other)

Parameter
Name	Description
`other`	`Example`

Returns
Type	Description
`Example.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Example.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Example.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Example.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Example.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePlaybookInput(PlaybookInput value)

public Example.Builder mergePlaybookInput(PlaybookInput value)

Optional. The input to the playbook in the example.

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

Parameter
Name	Description
`value`	`PlaybookInput`

Returns
Type	Description
`Example.Builder`

mergePlaybookOutput(PlaybookOutput value)

public Example.Builder mergePlaybookOutput(PlaybookOutput value)

Optional. The output of the playbook in the example.

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

Parameter
Name	Description
`value`	`PlaybookOutput`

Returns
Type	Description
`Example.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Example.Builder mergeUpdateTime(Timestamp value)

Output only. Last time the example was updated.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Example.Builder`

removeActions(int index)

public Example.Builder removeActions(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
`Example.Builder`

setActions(int index, Action value)

public Example.Builder setActions(int index, Action value)

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

Parameters
Name	Description
`index`	`int`
`value`	`Action`

Returns
Type	Description
`Example.Builder`

setActions(int index, Action.Builder builderForValue)

public Example.Builder setActions(int index, Action.Builder builderForValue)

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Action.Builder`

Returns
Type	Description
`Example.Builder`

setConversationState(OutputState value)

public Example.Builder setConversationState(OutputState value)

Required. Example's output state.

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

Parameter
Name	Description
`value`	`OutputState` The conversationState to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setConversationStateValue(int value)

public Example.Builder setConversationStateValue(int value)

Required. Example's output state.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for conversationState to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setCreateTime(Timestamp value)

public Example.Builder setCreateTime(Timestamp value)

Output only. The timestamp of initial example creation.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Example.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public Example.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp of initial example creation.

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Example.Builder`

setDescription(String value)

public Example.Builder setDescription(String value)

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

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

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public Example.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setDisplayName(String value)

public Example.Builder setDisplayName(String value)

Required. The display name of the example.

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

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Example.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the example.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLanguageCode(String value)

public Example.Builder setLanguageCode(String value)

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

Parameter
Name	Description
`value`	`String` The languageCode to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setLanguageCodeBytes(ByteString value)

public Example.Builder setLanguageCodeBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for languageCode to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setName(String value)

public Example.Builder setName(String value)

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;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Example.Builder setNameBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setPlaybookInput(PlaybookInput value)

public Example.Builder setPlaybookInput(PlaybookInput value)

Optional. The input to the playbook in the example.

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

Parameter
Name	Description
`value`	`PlaybookInput`

Returns
Type	Description
`Example.Builder`

setPlaybookInput(PlaybookInput.Builder builderForValue)

public Example.Builder setPlaybookInput(PlaybookInput.Builder builderForValue)

Optional. The input to the playbook in the example.

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

Parameter
Name	Description
`builderForValue`	`PlaybookInput.Builder`

Returns
Type	Description
`Example.Builder`

setPlaybookOutput(PlaybookOutput value)

public Example.Builder setPlaybookOutput(PlaybookOutput value)

Optional. The output of the playbook in the example.

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

Parameter
Name	Description
`value`	`PlaybookOutput`

Returns
Type	Description
`Example.Builder`

setPlaybookOutput(PlaybookOutput.Builder builderForValue)

public Example.Builder setPlaybookOutput(PlaybookOutput.Builder builderForValue)

Optional. The output of the playbook in the example.

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

Parameter
Name	Description
`builderForValue`	`PlaybookOutput.Builder`

Returns
Type	Description
`Example.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Example.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTokenCount(long value)

public Example.Builder setTokenCount(long value)

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

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

Parameter
Name	Description
`value`	`long` The tokenCount to set.

Returns
Type	Description
`Example.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Example.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Example.Builder setUpdateTime(Timestamp value)

Output only. Last time the example was updated.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Example.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public Example.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Last time the example was updated.

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Example.Builder`