public final class Webhook extends GeneratedMessageV3 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
Static Fields
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
GENERIC_WEB_SERVICE_FIELD_NUMBER
public static final int GENERIC_WEB_SERVICE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SERVICE_DIRECTORY_FIELD_NUMBER
public static final int SERVICE_DIRECTORY_FIELD_NUMBER
Field Value
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Webhook getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Webhook.Builder newBuilder()
Returns
newBuilder(Webhook prototype)
public static Webhook.Builder newBuilder(Webhook prototype)
Parameter
Returns
public static Webhook parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Webhook parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Webhook parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Webhook parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Webhook parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Webhook parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Webhook parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Webhook parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Webhook parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Webhook parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Webhook parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Webhook parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Webhook> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Webhook getDefaultInstanceForType()
Returns
getDisabled()
public boolean getDisabled()
Indicates whether the webhook is disabled.
bool disabled = 5;
Returns
Type |
Description |
boolean |
The disabled.
|
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];
Returns
Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The human-readable name of the webhook, unique within the agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type |
Description |
ByteString |
The bytes for displayName.
|
getGenericWebService()
public Webhook.GenericWebService getGenericWebService()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
Returns
getGenericWebServiceOrBuilder()
public Webhook.GenericWebServiceOrBuilder getGenericWebServiceOrBuilder()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
Returns
getName()
The unique identifier of the webhook.
Required for the Webhooks.UpdateWebhook method.
Webhooks.CreateWebhook populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/webhooks/<Webhook ID>
.
string name = 1;
Returns
Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
The unique identifier of the webhook.
Required for the Webhooks.UpdateWebhook method.
Webhooks.CreateWebhook populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/webhooks/<Webhook ID>
.
string name = 1;
Returns
getParserForType()
public Parser<Webhook> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceDirectory()
public Webhook.ServiceDirectoryConfig getServiceDirectory()
Configuration for a Service
Directory service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
Returns
getServiceDirectoryOrBuilder()
public Webhook.ServiceDirectoryConfigOrBuilder getServiceDirectoryOrBuilder()
Configuration for a Service
Directory service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
Returns
getTimeout()
public 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;
Returns
getTimeoutOrBuilder()
public 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;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWebhookCase()
public Webhook.WebhookCase getWebhookCase()
Returns
hasGenericWebService()
public boolean hasGenericWebService()
Configuration for a generic web service.
.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;
Returns
Type |
Description |
boolean |
Whether the genericWebService field is set.
|
hasServiceDirectory()
public boolean hasServiceDirectory()
Configuration for a Service
Directory service.
.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;
Returns
Type |
Description |
boolean |
Whether the serviceDirectory field is set.
|
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;
Returns
Type |
Description |
boolean |
Whether the timeout field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Webhook.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Webhook.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Webhook.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions