public static final class Webhook.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder> 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.v3.Webhook| Modifier and Type | Method and Description |
|---|---|
Webhook.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Webhook |
build() |
Webhook |
buildPartial() |
Webhook.Builder |
clear() |
Webhook.Builder |
clearDisabled()
Indicates whether the webhook is disabled.
|
Webhook.Builder |
clearDisplayName()
Required.
|
Webhook.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Webhook.Builder |
clearGenericWebService()
Configuration for a generic web service.
|
Webhook.Builder |
clearName()
The unique identifier of the webhook.
|
Webhook.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Webhook.Builder |
clearServiceDirectory()
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
Webhook.Builder |
clearTimeout()
Webhook execution timeout.
|
Webhook.Builder |
clearWebhook() |
Webhook.Builder |
clone() |
Webhook |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.GenericWebService.Builder |
getGenericWebServiceBuilder()
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.
|
Webhook.ServiceDirectoryConfig |
getServiceDirectory()
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
Webhook.ServiceDirectoryConfig.Builder |
getServiceDirectoryBuilder()
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.Duration.Builder |
getTimeoutBuilder()
Webhook execution timeout.
|
com.google.protobuf.DurationOrBuilder |
getTimeoutOrBuilder()
Webhook execution timeout.
|
Webhook.WebhookCase |
getWebhookCase() |
boolean |
hasGenericWebService()
Configuration for a generic web service.
|
boolean |
hasServiceDirectory()
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
boolean |
hasTimeout()
Webhook execution timeout.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Webhook.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Webhook.Builder |
mergeFrom(com.google.protobuf.Message other) |
Webhook.Builder |
mergeFrom(Webhook other) |
Webhook.Builder |
mergeGenericWebService(Webhook.GenericWebService value)
Configuration for a generic web service.
|
Webhook.Builder |
mergeServiceDirectory(Webhook.ServiceDirectoryConfig value)
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
Webhook.Builder |
mergeTimeout(com.google.protobuf.Duration value)
Webhook execution timeout.
|
Webhook.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Webhook.Builder |
setDisabled(boolean value)
Indicates whether the webhook is disabled.
|
Webhook.Builder |
setDisplayName(String value)
Required.
|
Webhook.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Required.
|
Webhook.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Webhook.Builder |
setGenericWebService(Webhook.GenericWebService.Builder builderForValue)
Configuration for a generic web service.
|
Webhook.Builder |
setGenericWebService(Webhook.GenericWebService value)
Configuration for a generic web service.
|
Webhook.Builder |
setName(String value)
The unique identifier of the webhook.
|
Webhook.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The unique identifier of the webhook.
|
Webhook.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Webhook.Builder |
setServiceDirectory(Webhook.ServiceDirectoryConfig.Builder builderForValue)
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
Webhook.Builder |
setServiceDirectory(Webhook.ServiceDirectoryConfig value)
Configuration for a [Service
Directory](https://cloud.google.com/service-directory) service.
|
Webhook.Builder |
setTimeout(com.google.protobuf.Duration.Builder builderForValue)
Webhook execution timeout.
|
Webhook.Builder |
setTimeout(com.google.protobuf.Duration value)
Webhook execution timeout.
|
Webhook.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Webhook build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Webhook buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Webhook.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Webhook.Builder>public Webhook.Builder mergeFrom(Webhook other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public Webhook.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Webhook.Builder>IOExceptionpublic Webhook.WebhookCase getWebhookCase()
getWebhookCase in interface WebhookOrBuilderpublic Webhook.Builder clearWebhook()
public String getName()
The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
string name = 1;getName in interface WebhookOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
string name = 1;getNameBytes in interface WebhookOrBuilderpublic Webhook.Builder setName(String value)
The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
string name = 1;value - The name to set.public Webhook.Builder clearName()
The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
string name = 1;public Webhook.Builder setNameBytes(com.google.protobuf.ByteString value)
The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
string name = 1;value - The bytes for name to set.public String getDisplayName()
Required. The human-readable name of the webhook, unique within the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface WebhookOrBuilderpublic 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];getDisplayNameBytes in interface WebhookOrBuilderpublic Webhook.Builder setDisplayName(String value)
Required. The human-readable name of the webhook, unique within the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The displayName to set.public Webhook.Builder clearDisplayName()
Required. The human-readable name of the webhook, unique within the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];public Webhook.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Required. The human-readable name of the webhook, unique within the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The bytes for displayName to set.public boolean hasGenericWebService()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
hasGenericWebService in interface WebhookOrBuilderpublic Webhook.GenericWebService getGenericWebService()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
getGenericWebService in interface WebhookOrBuilderpublic Webhook.Builder setGenericWebService(Webhook.GenericWebService value)
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
public Webhook.Builder setGenericWebService(Webhook.GenericWebService.Builder builderForValue)
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
public Webhook.Builder mergeGenericWebService(Webhook.GenericWebService value)
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
public Webhook.Builder clearGenericWebService()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
public Webhook.GenericWebService.Builder getGenericWebServiceBuilder()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
public Webhook.GenericWebServiceOrBuilder getGenericWebServiceOrBuilder()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
getGenericWebServiceOrBuilder in interface WebhookOrBuilderpublic boolean hasServiceDirectory()
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
hasServiceDirectory in interface WebhookOrBuilderpublic Webhook.ServiceDirectoryConfig getServiceDirectory()
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
getServiceDirectory in interface WebhookOrBuilderpublic Webhook.Builder setServiceDirectory(Webhook.ServiceDirectoryConfig value)
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
public Webhook.Builder setServiceDirectory(Webhook.ServiceDirectoryConfig.Builder builderForValue)
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
public Webhook.Builder mergeServiceDirectory(Webhook.ServiceDirectoryConfig value)
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
public Webhook.Builder clearServiceDirectory()
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
public Webhook.ServiceDirectoryConfig.Builder getServiceDirectoryBuilder()
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
public Webhook.ServiceDirectoryConfigOrBuilder getServiceDirectoryOrBuilder()
Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
getServiceDirectoryOrBuilder in interface WebhookOrBuilderpublic 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;hasTimeout in interface WebhookOrBuilderpublic 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;getTimeout in interface WebhookOrBuilderpublic Webhook.Builder setTimeout(com.google.protobuf.Duration value)
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;public Webhook.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)
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;public Webhook.Builder mergeTimeout(com.google.protobuf.Duration value)
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;public Webhook.Builder clearTimeout()
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;public com.google.protobuf.Duration.Builder getTimeoutBuilder()
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;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;getTimeoutOrBuilder in interface WebhookOrBuilderpublic boolean getDisabled()
Indicates whether the webhook is disabled.
bool disabled = 5;getDisabled in interface WebhookOrBuilderpublic Webhook.Builder setDisabled(boolean value)
Indicates whether the webhook is disabled.
bool disabled = 5;value - The disabled to set.public Webhook.Builder clearDisabled()
Indicates whether the webhook is disabled.
bool disabled = 5;public final Webhook.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>public final Webhook.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Webhook.Builder>Copyright © 2025 Google LLC. All rights reserved.