Package com.google.cloud.dialogflow.cx.v3beta1

Class EventHandler

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

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EVENT_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TARGET_FLOW_FIELD_NUMBER
     
    static final int
    TARGET_PAGE_FIELD_NUMBER
     
    static final int
    TARGET_PLAYBOOK_FIELD_NUMBER
     
    static final int
    TRIGGER_FULFILLMENT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static EventHandler
    getDefaultInstance()
     
    EventHandler
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEvent()
    Required.
    com.google.protobuf.ByteString
    getEventBytes()
    Required.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<EventHandler>
    getParserForType()
     
    int
    getSerializedSize()
     
    EventHandler.TargetCase
    getTargetCase()
     
    String
    getTargetFlow()
    The target flow to transition to.
    com.google.protobuf.ByteString
    getTargetFlowBytes()
    The target flow to transition to.
    String
    getTargetPage()
    The target page to transition to.
    com.google.protobuf.ByteString
    getTargetPageBytes()
    The target page to transition to.
    String
    getTargetPlaybook()
    The target playbook to transition to.
    com.google.protobuf.ByteString
    getTargetPlaybookBytes()
    The target playbook to transition to.
    Fulfillment
    getTriggerFulfillment()
    The fulfillment to call when the event occurs.
    FulfillmentOrBuilder
    getTriggerFulfillmentOrBuilder()
    The fulfillment to call when the event occurs.
    int
    hashCode()
     
    boolean
    hasTargetFlow()
    The target flow to transition to.
    boolean
    hasTargetPage()
    The target page to transition to.
    boolean
    hasTargetPlaybook()
    The target playbook to transition to.
    boolean
    hasTriggerFulfillment()
    The fulfillment to call when the event occurs.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EventHandler.Builder
    newBuilder()
     
    static EventHandler.Builder
    newBuilder(EventHandler prototype)
     
    EventHandler.Builder
    newBuilderForType()
     
    protected EventHandler.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static EventHandler
    parseDelimitedFrom(InputStream input)
     
    static EventHandler
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventHandler
    parseFrom(byte[] data)
     
    static EventHandler
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventHandler
    parseFrom(com.google.protobuf.ByteString data)
     
    static EventHandler
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventHandler
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EventHandler
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventHandler
    parseFrom(InputStream input)
     
    static EventHandler
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EventHandler
    parseFrom(ByteBuffer data)
     
    static EventHandler
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EventHandler>
    parser()
     
    EventHandler.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • EVENT_FIELD_NUMBER

      public static final int EVENT_FIELD_NUMBER
      See Also:

    • TRIGGER_FULFILLMENT_FIELD_NUMBER

      public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
      See Also:

    • TARGET_PAGE_FIELD_NUMBER

      public static final int TARGET_PAGE_FIELD_NUMBER
      See Also:

    • TARGET_FLOW_FIELD_NUMBER

      public static final int TARGET_FLOW_FIELD_NUMBER
      See Also:

    • TARGET_PLAYBOOK_FIELD_NUMBER

      public static final int TARGET_PLAYBOOK_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getTargetCase

      public EventHandler.TargetCase getTargetCase()
      Specified by:
      getTargetCase in interface EventHandlerOrBuilder

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

    • hasTargetPage

      public boolean hasTargetPage()
       The target page to transition to.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
      string target_flow = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getTargetFlowBytes in interface EventHandlerOrBuilder
      Returns:
      The bytes for targetFlow.

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

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

    • getTargetPlaybookBytes

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

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static EventHandler parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EventHandler parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static EventHandler.Builder newBuilder()

    • newBuilder

      public static EventHandler.Builder newBuilder(EventHandler prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

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

    • getDefaultInstanceForType

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