com.google.cloud.dialogflow.cx.v3

Interface WebhookOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Webhook, Webhook.Builder

public interface WebhookOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
boolean	hasServiceDirectory() Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
boolean	hasTimeout() Webhook execution timeout.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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;

Returns:

The name.

getNameBytes

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;

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Required. The human-readable name of the webhook, unique within the agent.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The displayName.

getDisplayNameBytes

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];

Returns:

The bytes for displayName.

hasGenericWebService

boolean hasGenericWebService()

 Configuration for a generic web service.
 

.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;

Returns:

Whether the genericWebService field is set.

getGenericWebService

Webhook.GenericWebService getGenericWebService()

 Configuration for a generic web service.
 

.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;

Returns:

The genericWebService.

getGenericWebServiceOrBuilder

Webhook.GenericWebServiceOrBuilder getGenericWebServiceOrBuilder()

 Configuration for a generic web service.
 

.google.cloud.dialogflow.cx.v3.Webhook.GenericWebService generic_web_service = 4;

hasServiceDirectory

boolean hasServiceDirectory()

 Configuration for a [Service
 Directory](https://cloud.google.com/service-directory) service.
 

.google.cloud.dialogflow.cx.v3.Webhook.ServiceDirectoryConfig service_directory = 7;

Returns:

Whether the serviceDirectory field is set.

getServiceDirectory

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;

Returns:

The serviceDirectory.

getServiceDirectoryOrBuilder

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;

hasTimeout

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:

Whether the timeout field is set.

getTimeout

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;

Returns:

The timeout.

getTimeoutOrBuilder

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;

getDisabled

boolean getDisabled()

 Indicates whether the webhook is disabled.
 

bool disabled = 5;

Returns:

The disabled.

getWebhookCase

Webhook.WebhookCase getWebhookCase()