Package com.google.cloud.dialogflow.cx.v3

Class EventHandler

  • All Implemented Interfaces:
    EventHandlerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class EventHandler
extends com.google.protobuf.GeneratedMessageV3
implements EventHandlerOrBuilder
     An event handler specifies an
 [event][google.cloud.dialogflow.cx.v3.EventHandler.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`][google.cloud.dialogflow.cx.v3.EventHandler.trigger_fulfillment]
 associated with the event, it will be called.
 *   If there is a
 [`target_page`][google.cloud.dialogflow.cx.v3.EventHandler.target_page]
 associated with the event, the session will transition into the specified
 page.
 *   If there is a
 [`target_flow`][google.cloud.dialogflow.cx.v3.EventHandler.target_flow]
 associated with the event, the session will transition into the specified
 flow.
    Protobuf type google.cloud.dialogflow.cx.v3.EventHandler
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  EventHandler.Builder
      An event handler specifies an [event][google.cloud.dialogflow.cx.v3.EventHandler.event] that can be handled during a session.
      static class  EventHandler.TargetCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The unique identifier of this event handler.
        string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface EventHandlerOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The unique identifier of this event handler.
        string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface EventHandlerOrBuilder
        Returns:
        The bytes for name.

      • getEvent

        public String getEvent()
         Required. The name of the event to handle.
        string event = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEvent in interface EventHandlerOrBuilder
        Returns:
        The event.

      • getEventBytes

        public com.google.protobuf.ByteString getEventBytes()
         Required. The name of the event to handle.
        string event = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getEventBytes in interface EventHandlerOrBuilder
        Returns:
        The bytes for event.

      • 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.v3.Fulfillment trigger_fulfillment = 5;
        Specified by:
        hasTriggerFulfillment in interface EventHandlerOrBuilder
        Returns:
        Whether the triggerFulfillment field is set.

      • 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.v3.Fulfillment trigger_fulfillment = 5;
        Specified by:
        getTriggerFulfillment in interface EventHandlerOrBuilder
        Returns:
        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.v3.Fulfillment trigger_fulfillment = 5;
        Specified by:
        getTriggerFulfillmentOrBuilder in interface EventHandlerOrBuilder

      • 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) = { ... }
        Specified by:
        hasTargetPage in interface EventHandlerOrBuilder
        Returns:
        Whether the targetPage field is set.

      • 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) = { ... }
        Specified by:
        getTargetPage in interface EventHandlerOrBuilder
        Returns:
        The targetPage.

      • getTargetPageBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetPageBytes in interface EventHandlerOrBuilder
        Returns:
        The bytes for targetPage.

      • 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) = { ... }
        Specified by:
        hasTargetFlow in interface EventHandlerOrBuilder
        Returns:
        Whether the targetFlow field is set.

      • 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) = { ... }
        Specified by:
        getTargetFlow in interface EventHandlerOrBuilder
        Returns:
        The targetFlow.

      • getTargetFlowBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetFlowBytes in interface EventHandlerOrBuilder
        Returns:
        The bytes for targetFlow.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static EventHandler parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static EventHandler parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public EventHandler.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public EventHandler.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected EventHandler.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static EventHandler getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<EventHandler> parser()

      • getParserForType

        public com.google.protobuf.Parser<EventHandler> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public EventHandler getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder