public static final class GuidanceInstruction.Builder extends GeneratedMessage.Builder<GuidanceInstruction.Builder> implements GuidanceInstructionOrBuilderGuidance instruction for the companion agent.
Protobuf type google.cloud.dialogflow.v2.GuidanceInstruction
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GuidanceInstruction.BuilderImplements
GuidanceInstructionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addActions(GuidanceInstruction.Action value)
public GuidanceInstruction.Builder addActions(GuidanceInstruction.Action value)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GuidanceInstruction.Action |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
addActions(GuidanceInstruction.Action.Builder builderForValue)
public GuidanceInstruction.Builder addActions(GuidanceInstruction.Action.Builder builderForValue)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GuidanceInstruction.Action.Builder |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
addActions(int index, GuidanceInstruction.Action value)
public GuidanceInstruction.Builder addActions(int index, GuidanceInstruction.Action value)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GuidanceInstruction.Action |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
addActions(int index, GuidanceInstruction.Action.Builder builderForValue)
public GuidanceInstruction.Builder addActions(int index, GuidanceInstruction.Action.Builder builderForValue)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GuidanceInstruction.Action.Builder |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
addActionsBuilder()
public GuidanceInstruction.Action.Builder addActionsBuilder()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Action.Builder |
|
addActionsBuilder(int index)
public GuidanceInstruction.Action.Builder addActionsBuilder(int index)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Action.Builder |
|
addAllActions(Iterable<? extends GuidanceInstruction.Action> values)
public GuidanceInstruction.Builder addAllActions(Iterable<? extends GuidanceInstruction.Action> values)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.v2.GuidanceInstruction.Action> |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
build()
public GuidanceInstruction build()| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction |
|
buildPartial()
public GuidanceInstruction buildPartial()| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction |
|
clear()
public GuidanceInstruction.Builder clear()| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
clearActions()
public GuidanceInstruction.Builder clearActions()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
clearCondition()
public GuidanceInstruction.Builder clearCondition()Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.
string condition = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
clearDisableSuggestedReply()
public GuidanceInstruction.Builder clearDisableSuggestedReply() Optional. Whether to disable suggested reply generation for this
instruction. When set to true, guidance generated from this instruction
will not include a suggested reply. Default is false (suggested reply
enabled).
bool disable_suggested_reply = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
clearDisplayDetails()
public GuidanceInstruction.Builder clearDisplayDetails()Optional. The detailed description of this instruction.
string display_details = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
clearDisplayName()
public GuidanceInstruction.Builder clearDisplayName()Optional. Display name for the instruction. This name should be unique within the companion agent.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
clearTriggerEvent()
public GuidanceInstruction.Builder clearTriggerEvent()Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.
.google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent trigger_event = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
getActions(int index)
public GuidanceInstruction.Action getActions(int index)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Action |
|
getActionsBuilder(int index)
public GuidanceInstruction.Action.Builder getActionsBuilder(int index)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Action.Builder |
|
getActionsBuilderList()
public List<GuidanceInstruction.Action.Builder> getActionsBuilderList()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getActionsCount()
public int getActionsCount()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getActionsList()
public List<GuidanceInstruction.Action> getActionsList()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Action> |
|
getActionsOrBuilder(int index)
public GuidanceInstruction.ActionOrBuilder getActionsOrBuilder(int index)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.ActionOrBuilder |
|
getActionsOrBuilderList()
public List<? extends GuidanceInstruction.ActionOrBuilder> getActionsOrBuilderList()Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.v2.GuidanceInstruction.ActionOrBuilder> |
|
getCondition()
public String getCondition()Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.
string condition = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The condition. |
getConditionBytes()
public ByteString getConditionBytes()Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.
string condition = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for condition. |
getDefaultInstanceForType()
public GuidanceInstruction getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisableSuggestedReply()
public boolean getDisableSuggestedReply() Optional. Whether to disable suggested reply generation for this
instruction. When set to true, guidance generated from this instruction
will not include a suggested reply. Default is false (suggested reply
enabled).
bool disable_suggested_reply = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The disableSuggestedReply. |
getDisplayDetails()
public String getDisplayDetails()Optional. The detailed description of this instruction.
string display_details = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayDetails. |
getDisplayDetailsBytes()
public ByteString getDisplayDetailsBytes()Optional. The detailed description of this instruction.
string display_details = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayDetails. |
getDisplayName()
public String getDisplayName()Optional. Display name for the instruction. This name should be unique within the companion agent.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Optional. Display name for the instruction. This name should be unique within the companion agent.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getTriggerEvent()
public CompanionAgent.TriggerEvent getTriggerEvent()Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.
.google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent trigger_event = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CompanionAgent.TriggerEvent |
The triggerEvent. |
getTriggerEventValue()
public int getTriggerEventValue()Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.
.google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent trigger_event = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for triggerEvent. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GuidanceInstruction other)
public GuidanceInstruction.Builder mergeFrom(GuidanceInstruction other)| Parameter | |
|---|---|
| Name | Description |
other |
GuidanceInstruction |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GuidanceInstruction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GuidanceInstruction.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
removeActions(int index)
public GuidanceInstruction.Builder removeActions(int index)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
setActions(int index, GuidanceInstruction.Action value)
public GuidanceInstruction.Builder setActions(int index, GuidanceInstruction.Action value)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GuidanceInstruction.Action |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
setActions(int index, GuidanceInstruction.Action.Builder builderForValue)
public GuidanceInstruction.Builder setActions(int index, GuidanceInstruction.Action.Builder builderForValue)Optional. The action items that can be processed.
repeated .google.cloud.dialogflow.v2.GuidanceInstruction.Action actions = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GuidanceInstruction.Action.Builder |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
setCondition(String value)
public GuidanceInstruction.Builder setCondition(String value)Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.
string condition = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setConditionBytes(ByteString value)
public GuidanceInstruction.Builder setConditionBytes(ByteString value)Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.
string condition = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for condition to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setDisableSuggestedReply(boolean value)
public GuidanceInstruction.Builder setDisableSuggestedReply(boolean value) Optional. Whether to disable suggested reply generation for this
instruction. When set to true, guidance generated from this instruction
will not include a suggested reply. Default is false (suggested reply
enabled).
bool disable_suggested_reply = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe disableSuggestedReply to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setDisplayDetails(String value)
public GuidanceInstruction.Builder setDisplayDetails(String value)Optional. The detailed description of this instruction.
string display_details = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayDetails to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setDisplayDetailsBytes(ByteString value)
public GuidanceInstruction.Builder setDisplayDetailsBytes(ByteString value)Optional. The detailed description of this instruction.
string display_details = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayDetails to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setDisplayName(String value)
public GuidanceInstruction.Builder setDisplayName(String value)Optional. Display name for the instruction. This name should be unique within the companion agent.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public GuidanceInstruction.Builder setDisplayNameBytes(ByteString value)Optional. Display name for the instruction. This name should be unique within the companion agent.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setTriggerEvent(CompanionAgent.TriggerEvent value)
public GuidanceInstruction.Builder setTriggerEvent(CompanionAgent.TriggerEvent value)Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.
.google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent trigger_event = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CompanionAgent.TriggerEventThe triggerEvent to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |
setTriggerEventValue(int value)
public GuidanceInstruction.Builder setTriggerEventValue(int value)Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.
.google.cloud.dialogflow.v2.CompanionAgent.TriggerEvent trigger_event = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for triggerEvent to set. |
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
This builder for chaining. |