public final class EventHandler extends GeneratedMessageV3 implements EventHandlerOrBuilder
An event handler specifies an
event that can be
handled during a session. When the specified event happens, the following
actions are taken in order:
- If there is a
trigger_fulfillment
associated with the event, it will be called.
- If there is a
target_page
associated with the event, the session will transition into the specified
page.
- If there is a
target_flow
associated with the event, the session will transition into the specified
flow.
Protobuf type google.cloud.dialogflow.cx.v3beta1.EventHandler
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EVENT_FIELD_NUMBER
public static final int EVENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TARGET_FLOW_FIELD_NUMBER
public static final int TARGET_FLOW_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TARGET_PAGE_FIELD_NUMBER
public static final int TARGET_PAGE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TRIGGER_FULFILLMENT_FIELD_NUMBER
public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static EventHandler getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EventHandler.Builder newBuilder()
newBuilder(EventHandler prototype)
public static EventHandler.Builder newBuilder(EventHandler prototype)
public static EventHandler parseDelimitedFrom(InputStream input)
public static EventHandler parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EventHandler parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EventHandler parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EventHandler parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventHandler parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventHandler parseFrom(CodedInputStream input)
public static EventHandler parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EventHandler parseFrom(InputStream input)
public static EventHandler parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EventHandler parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EventHandler parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EventHandler> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public EventHandler getDefaultInstanceForType()
getEvent()
Required. The name of the event to handle.
string event = 4 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
String |
The event.
|
getEventBytes()
public ByteString getEventBytes()
Required. The name of the event to handle.
string event = 4 [(.google.api.field_behavior) = REQUIRED];
Returns |
Type |
Description |
ByteString |
The bytes for event.
|
getName()
Output only. The unique identifier of this event handler.
string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The unique identifier of this event handler.
string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<EventHandler> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getTargetCase()
public EventHandler.TargetCase getTargetCase()
getTargetFlow()
public String getTargetFlow()
The target flow to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
string target_flow = 3 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
String |
The targetFlow.
|
getTargetFlowBytes()
public ByteString getTargetFlowBytes()
The target flow to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
string target_flow = 3 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
ByteString |
The bytes for targetFlow.
|
getTargetPage()
public String getTargetPage()
The target page to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
string target_page = 2 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
String |
The targetPage.
|
getTargetPageBytes()
public ByteString getTargetPageBytes()
The target page to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
string target_page = 2 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
ByteString |
The bytes for targetPage.
|
getTriggerFulfillment()
public Fulfillment getTriggerFulfillment()
The fulfillment to call when the event occurs.
Handling webhook errors with a fulfillment enabled with webhook could
cause infinite loop. It is invalid to specify such fulfillment for a
handler handling webhooks.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
Returns |
Type |
Description |
Fulfillment |
The triggerFulfillment.
|
getTriggerFulfillmentOrBuilder()
public FulfillmentOrBuilder getTriggerFulfillmentOrBuilder()
The fulfillment to call when the event occurs.
Handling webhook errors with a fulfillment enabled with webhook could
cause infinite loop. It is invalid to specify such fulfillment for a
handler handling webhooks.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
hasTargetFlow()
public boolean hasTargetFlow()
The target flow to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
string target_flow = 3 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
boolean |
Whether the targetFlow field is set.
|
hasTargetPage()
public boolean hasTargetPage()
The target page to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
string target_page = 2 [(.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
boolean |
Whether the targetPage field is set.
|
hasTriggerFulfillment()
public boolean hasTriggerFulfillment()
The fulfillment to call when the event occurs.
Handling webhook errors with a fulfillment enabled with webhook could
cause infinite loop. It is invalid to specify such fulfillment for a
handler handling webhooks.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
Returns |
Type |
Description |
boolean |
Whether the triggerFulfillment field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public EventHandler.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EventHandler.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public EventHandler.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides