Class EventHandler.Builder (0.54.0)

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

Implements

EventHandlerOrBuilder

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

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`

Overrides

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

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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`

Overrides

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

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`

Overrides

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

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.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public EventHandler getDefaultInstanceForType()

Returns
Type	Description
`EventHandler`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getTriggerFulfillment()

public Fulfillment getTriggerFulfillment()

.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;

Returns
Type	Description
`Fulfillment`	The triggerFulfillment.

getTriggerFulfillmentBuilder()

public Fulfillment.Builder getTriggerFulfillmentBuilder()

.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;

Returns
Type	Description
`Fulfillment.Builder`

getTriggerFulfillmentOrBuilder()

public FulfillmentOrBuilder getTriggerFulfillmentOrBuilder()

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

hasTriggerFulfillment()

public boolean hasTriggerFulfillment()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public EventHandler.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`EventHandler.Builder`

Overrides

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

mergeTriggerFulfillment(Fulfillment value)

public EventHandler.Builder mergeTriggerFulfillment(Fulfillment value)

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

Overrides

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

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`

Overrides

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

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`

Overrides

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

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.

setTriggerFulfillment(Fulfillment value)

public EventHandler.Builder setTriggerFulfillment(Fulfillment value)

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

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

Overrides

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