- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 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 static final class EventHandler.Builder extends GeneratedMessageV3.Builder<EventHandler.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EventHandler.BuilderImplements
EventHandlerOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public EventHandler.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
build()
public EventHandler build()
Returns | |
---|---|
Type | Description |
EventHandler |
buildPartial()
public EventHandler buildPartial()
Returns | |
---|---|
Type | Description |
EventHandler |
clear()
public EventHandler.Builder clear()
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
clearEvent()
public EventHandler.Builder clearEvent()
Required. The name of the event to handle.
string event = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public EventHandler.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
clearName()
public EventHandler.Builder clearName()
Output only. The unique identifier of this event handler.
string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public EventHandler.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
clearTarget()
public EventHandler.Builder clearTarget()
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
clearTargetFlow()
public EventHandler.Builder clearTargetFlow()
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 |
EventHandler.Builder |
This builder for chaining. |
clearTargetPage()
public EventHandler.Builder clearTargetPage()
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 |
EventHandler.Builder |
This builder for chaining. |
clearTargetPlaybook()
public EventHandler.Builder clearTargetPlaybook()
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
clearTriggerFulfillment()
public EventHandler.Builder clearTriggerFulfillment()
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 |
EventHandler.Builder |
clone()
public EventHandler.Builder clone()
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
getDefaultInstanceForType()
public EventHandler getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
EventHandler |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEvent()
public String 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()
public String 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. |
getTargetCase()
public EventHandler.TargetCase getTargetCase()
Returns | |
---|---|
Type | Description |
EventHandler.TargetCase |
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. |
getTargetPlaybook()
public String getTargetPlaybook()
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The targetPlaybook. |
getTargetPlaybookBytes()
public ByteString getTargetPlaybookBytes()
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for targetPlaybook. |
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. |
getTriggerFulfillmentBuilder()
public Fulfillment.Builder getTriggerFulfillmentBuilder()
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.Builder |
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;
Returns | |
---|---|
Type | Description |
FulfillmentOrBuilder |
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. |
hasTargetPlaybook()
public boolean hasTargetPlaybook()
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
boolean |
Whether the targetPlaybook 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(EventHandler other)
public EventHandler.Builder mergeFrom(EventHandler other)
Parameter | |
---|---|
Name | Description |
other |
EventHandler |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public EventHandler.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public EventHandler.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
mergeTriggerFulfillment(Fulfillment value)
public EventHandler.Builder mergeTriggerFulfillment(Fulfillment value)
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;
Parameter | |
---|---|
Name | Description |
value |
Fulfillment |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final EventHandler.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
setEvent(String value)
public EventHandler.Builder setEvent(String value)
Required. The name of the event to handle.
string event = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The event to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setEventBytes(ByteString value)
public EventHandler.Builder setEventBytes(ByteString value)
Required. The name of the event to handle.
string event = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for event to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public EventHandler.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
setName(String value)
public EventHandler.Builder setName(String value)
Output only. The unique identifier of this event handler.
string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public EventHandler.Builder setNameBytes(ByteString value)
Output only. The unique identifier of this event handler.
string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public EventHandler.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
setTargetFlow(String value)
public EventHandler.Builder setTargetFlow(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The targetFlow to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTargetFlowBytes(ByteString value)
public EventHandler.Builder setTargetFlowBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for targetFlow to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTargetPage(String value)
public EventHandler.Builder setTargetPage(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The targetPage to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTargetPageBytes(ByteString value)
public EventHandler.Builder setTargetPageBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for targetPage to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTargetPlaybook(String value)
public EventHandler.Builder setTargetPlaybook(String value)
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The targetPlaybook to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTargetPlaybookBytes(ByteString value)
public EventHandler.Builder setTargetPlaybookBytes(ByteString value)
The target playbook to transition to.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>
.
string target_playbook = 7 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for targetPlaybook to set. |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
This builder for chaining. |
setTriggerFulfillment(Fulfillment value)
public EventHandler.Builder setTriggerFulfillment(Fulfillment value)
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;
Parameter | |
---|---|
Name | Description |
value |
Fulfillment |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
setTriggerFulfillment(Fulfillment.Builder builderForValue)
public EventHandler.Builder setTriggerFulfillment(Fulfillment.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Fulfillment.Builder |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final EventHandler.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
EventHandler.Builder |