Class GuidanceInstruction (4.105.0)

public final class GuidanceInstruction extends GeneratedMessage implements GuidanceInstructionOrBuilder

Guidance instruction for the companion agent.

Protobuf type google.cloud.dialogflow.v2.GuidanceInstruction

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_SUGGESTED_REPLY_FIELD_NUMBER

public static final int DISABLE_SUGGESTED_REPLY_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_DETAILS_FIELD_NUMBER

public static final int DISPLAY_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_EVENT_FIELD_NUMBER

public static final int TRIGGER_EVENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GuidanceInstruction getDefaultInstance()
Returns
Type Description
GuidanceInstruction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GuidanceInstruction.Builder newBuilder()
Returns
Type Description
GuidanceInstruction.Builder

newBuilder(GuidanceInstruction prototype)

public static GuidanceInstruction.Builder newBuilder(GuidanceInstruction prototype)
Parameter
Name Description
prototype GuidanceInstruction
Returns
Type Description
GuidanceInstruction.Builder

parseDelimitedFrom(InputStream input)

public static GuidanceInstruction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GuidanceInstruction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GuidanceInstruction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GuidanceInstruction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GuidanceInstruction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GuidanceInstruction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GuidanceInstruction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuidanceInstruction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GuidanceInstruction> parser()
Returns
Type Description
Parser<GuidanceInstruction>

Methods

equals(Object obj)

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

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

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 GuidanceInstruction.Builder newBuilderForType()
Returns
Type Description
GuidanceInstruction.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected GuidanceInstruction.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GuidanceInstruction.Builder
Overrides

toBuilder()

public GuidanceInstruction.Builder toBuilder()
Returns
Type Description
GuidanceInstruction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException