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

Class Webhook

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Webhook
All Implemented Interfaces:
WebhookOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Webhook extends com.google.protobuf.GeneratedMessage implements WebhookOrBuilder
 Webhooks host the developer's business logic. During a session, webhooks
 allow the developer to use the data extracted by Dialogflow's natural
 language processing to generate dynamic responses, validate collected data,
 or trigger actions on the backend.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Webhook.Builder
    Webhooks host the developer's business logic.
    static final class 
    Webhook.GenericWebService
    Represents configuration for a generic web service.
    static interface 
    Webhook.GenericWebServiceOrBuilder
     
    static final class 
    Webhook.ServiceDirectoryConfig
    Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
    static interface 
    Webhook.ServiceDirectoryConfigOrBuilder
     
    static enum 
    Webhook.WebhookCase
     

    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
    DISABLED_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    GENERIC_WEB_SERVICE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SERVICE_DIRECTORY_FIELD_NUMBER
     
    static final int
    TIMEOUT_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 Webhook
    getDefaultInstance()
     
    Webhook
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisabled()
    Indicates whether the webhook is disabled.
    String
    getDisplayName()
    Required.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Required.
    Webhook.GenericWebService
    getGenericWebService()
    Configuration for a generic web service.
    Webhook.GenericWebServiceOrBuilder
    getGenericWebServiceOrBuilder()
    Configuration for a generic web service.
    String
    getName()
    The unique identifier of the webhook.
    com.google.protobuf.ByteString
    getNameBytes()
    The unique identifier of the webhook.
    com.google.protobuf.Parser<Webhook>
    getParserForType()
     
    int
    getSerializedSize()
     
    Webhook.ServiceDirectoryConfig
    getServiceDirectory()
    Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
    Webhook.ServiceDirectoryConfigOrBuilder
    getServiceDirectoryOrBuilder()
    Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
    com.google.protobuf.Duration
    getTimeout()
    Webhook execution timeout.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    Webhook execution timeout.
    Webhook.WebhookCase
    getWebhookCase()
     
    boolean
    hasGenericWebService()
    Configuration for a generic web service.
    int
    hashCode()
     
    boolean
    hasServiceDirectory()
    Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
    boolean
    hasTimeout()
    Webhook execution timeout.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Webhook.Builder
    newBuilder()
     
    static Webhook.Builder
    newBuilder(Webhook prototype)
     
    Webhook.Builder
    newBuilderForType()
     
    protected Webhook.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Webhook
    parseDelimitedFrom(InputStream input)
     
    static Webhook
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Webhook
    parseFrom(byte[] data)
     
    static Webhook
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Webhook
    parseFrom(com.google.protobuf.ByteString data)
     
    static Webhook
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Webhook
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Webhook
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Webhook
    parseFrom(InputStream input)
     
    static Webhook
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Webhook
    parseFrom(ByteBuffer data)
     
    static Webhook
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Webhook>
    parser()
     
    Webhook.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:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • GENERIC_WEB_SERVICE_FIELD_NUMBER

      public static final int GENERIC_WEB_SERVICE_FIELD_NUMBER
      See Also:

    • SERVICE_DIRECTORY_FIELD_NUMBER

      public static final int SERVICE_DIRECTORY_FIELD_NUMBER
      See Also:

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:

    • DISABLED_FIELD_NUMBER

      public static final int DISABLED_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

    • getWebhookCase

      public Webhook.WebhookCase getWebhookCase()
      Specified by:
      getWebhookCase in interface WebhookOrBuilder

    • getName

      public String getName()
       The unique identifier of the webhook.
 Required for the
 [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook]
 method.
 [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
      string name = 1;
      Specified by:
      getName in interface WebhookOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The unique identifier of the webhook.
 Required for the
 [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook]
 method.
 [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook]
 populates the name automatically. Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
      string name = 1;
      Specified by:
      getNameBytes in interface WebhookOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The human-readable name of the webhook, unique within the agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface WebhookOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human-readable name of the webhook, unique within the agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface WebhookOrBuilder
      Returns:
      The bytes for displayName.

    • hasGenericWebService

      public boolean hasGenericWebService()
       Configuration for a generic web service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
      Specified by:
      hasGenericWebService in interface WebhookOrBuilder
      Returns:
      Whether the genericWebService field is set.

    • getGenericWebService

      public Webhook.GenericWebService getGenericWebService()
       Configuration for a generic web service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
      Specified by:
      getGenericWebService in interface WebhookOrBuilder
      Returns:
      The genericWebService.

    • getGenericWebServiceOrBuilder

      public Webhook.GenericWebServiceOrBuilder getGenericWebServiceOrBuilder()
       Configuration for a generic web service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
      Specified by:
      getGenericWebServiceOrBuilder in interface WebhookOrBuilder

    • hasServiceDirectory

      public boolean hasServiceDirectory()
       Configuration for a [Service
 Directory](https://cloud.google.com/service-directory) service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
      Specified by:
      hasServiceDirectory in interface WebhookOrBuilder
      Returns:
      Whether the serviceDirectory field is set.

    • getServiceDirectory

      public Webhook.ServiceDirectoryConfig getServiceDirectory()
       Configuration for a [Service
 Directory](https://cloud.google.com/service-directory) service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
      Specified by:
      getServiceDirectory in interface WebhookOrBuilder
      Returns:
      The serviceDirectory.

    • getServiceDirectoryOrBuilder

      public Webhook.ServiceDirectoryConfigOrBuilder getServiceDirectoryOrBuilder()
       Configuration for a [Service
 Directory](https://cloud.google.com/service-directory) service.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
      Specified by:
      getServiceDirectoryOrBuilder in interface WebhookOrBuilder

    • hasTimeout

      public boolean hasTimeout()
       Webhook execution timeout. Execution is considered failed if Dialogflow
 doesn't receive a response from webhook at the end of the timeout period.
 Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      .google.protobuf.Duration timeout = 6;
      Specified by:
      hasTimeout in interface WebhookOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public com.google.protobuf.Duration getTimeout()
       Webhook execution timeout. Execution is considered failed if Dialogflow
 doesn't receive a response from webhook at the end of the timeout period.
 Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      .google.protobuf.Duration timeout = 6;
      Specified by:
      getTimeout in interface WebhookOrBuilder
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       Webhook execution timeout. Execution is considered failed if Dialogflow
 doesn't receive a response from webhook at the end of the timeout period.
 Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
      .google.protobuf.Duration timeout = 6;
      Specified by:
      getTimeoutOrBuilder in interface WebhookOrBuilder

    • getDisabled

      public boolean getDisabled()
       Indicates whether the webhook is disabled.
      bool disabled = 5;
      Specified by:
      getDisabled in interface WebhookOrBuilder
      Returns:
      The disabled.

    • 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 Webhook parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Webhook parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Webhook.Builder newBuilder()

    • newBuilder

      public static Webhook.Builder newBuilder(Webhook prototype)

    • toBuilder

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

    • newBuilderForType

      protected Webhook.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Webhook getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Webhook> 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 Webhook getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder