Interface WebhookRequestOrBuilder (0.25.0)

Version 0.25.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface WebhookRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDetectIntentResponseId()

public abstract String getDetectIntentResponseId()

Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

string detect_intent_response_id = 1;

Returns
Type	Description
String	The detectIntentResponseId.

getDetectIntentResponseIdBytes()

public abstract ByteString getDetectIntentResponseIdBytes()

Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

string detect_intent_response_id = 1;

Returns
Type	Description
ByteString	The bytes for detectIntentResponseId.

getFulfillmentInfo()

public abstract WebhookRequest.FulfillmentInfo getFulfillmentInfo()

Always present. Information about the fulfillment that triggered this webhook call.

.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;

Returns
Type	Description
WebhookRequest.FulfillmentInfo	The fulfillmentInfo.

getFulfillmentInfoOrBuilder()

public abstract WebhookRequest.FulfillmentInfoOrBuilder getFulfillmentInfoOrBuilder()

Always present. Information about the fulfillment that triggered this webhook call.

.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;

Returns
Type	Description
WebhookRequest.FulfillmentInfoOrBuilder

getIntentInfo()

public abstract WebhookRequest.IntentInfo getIntentInfo()

Information about the last matched intent.

.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;

Returns
Type	Description
WebhookRequest.IntentInfo	The intentInfo.

getIntentInfoOrBuilder()

public abstract WebhookRequest.IntentInfoOrBuilder getIntentInfoOrBuilder()

Information about the last matched intent.

.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;

Returns
Type	Description
WebhookRequest.IntentInfoOrBuilder

getLanguageCode()

public abstract String getLanguageCode()

The language code specified in the original request.

string language_code = 15;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

The language code specified in the original request.

string language_code = 15;

Returns
Type	Description
ByteString	The bytes for languageCode.

getMessages(int index)

public abstract ResponseMessage getMessages(int index)

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
ResponseMessage

getMessagesCount()

public abstract int getMessagesCount()

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;

Returns
Type	Description
int

getMessagesList()

public abstract List<ResponseMessage> getMessagesList()

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;

Returns
Type	Description
List<ResponseMessage>

getMessagesOrBuilder(int index)

public abstract ResponseMessageOrBuilder getMessagesOrBuilder(int index)

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
ResponseMessageOrBuilder

getMessagesOrBuilderList()

public abstract List<? extends ResponseMessageOrBuilder> getMessagesOrBuilderList()

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3.ResponseMessageOrBuilder>

getPageInfo()

public abstract PageInfo getPageInfo()

Information about page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;

Returns
Type	Description
PageInfo	The pageInfo.

getPageInfoOrBuilder()

public abstract PageInfoOrBuilder getPageInfoOrBuilder()

Information about page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;

Returns
Type	Description
PageInfoOrBuilder

getPayload()

public abstract Struct getPayload()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type	Description
Struct	The payload.

getPayloadOrBuilder()

public abstract StructOrBuilder getPayloadOrBuilder()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type	Description
StructOrBuilder

getQueryCase()

public abstract WebhookRequest.QueryCase getQueryCase()

Returns
Type	Description
WebhookRequest.QueryCase

getSentimentAnalysisResult()

public abstract WebhookRequest.SentimentAnalysisResult getSentimentAnalysisResult()

The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;

Returns
Type	Description
WebhookRequest.SentimentAnalysisResult	The sentimentAnalysisResult.

getSentimentAnalysisResultOrBuilder()

public abstract WebhookRequest.SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()

The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;

Returns
Type	Description
WebhookRequest.SentimentAnalysisResultOrBuilder

getSessionInfo()

public abstract SessionInfo getSessionInfo()

Information about session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;

Returns
Type	Description
SessionInfo	The sessionInfo.

getSessionInfoOrBuilder()

public abstract SessionInfoOrBuilder getSessionInfoOrBuilder()

Information about session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;

Returns
Type	Description
SessionInfoOrBuilder

getText()

public abstract String getText()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 10;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 10;

Returns
Type	Description
ByteString	The bytes for text.

getTranscript()

public abstract String getTranscript()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type	Description
String	The transcript.

getTranscriptBytes()

public abstract ByteString getTranscriptBytes()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type	Description
ByteString	The bytes for transcript.

getTriggerEvent()

public abstract String getTriggerEvent()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type	Description
String	The triggerEvent.

getTriggerEventBytes()

public abstract ByteString getTriggerEventBytes()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type	Description
ByteString	The bytes for triggerEvent.

getTriggerIntent()

public abstract String getTriggerIntent()

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string trigger_intent = 11 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The triggerIntent.

getTriggerIntentBytes()

public abstract ByteString getTriggerIntentBytes()

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string trigger_intent = 11 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for triggerIntent.

hasFulfillmentInfo()

public abstract boolean hasFulfillmentInfo()

Always present. Information about the fulfillment that triggered this webhook call.

.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;

Returns
Type	Description
boolean	Whether the fulfillmentInfo field is set.

hasIntentInfo()

public abstract boolean hasIntentInfo()

Information about the last matched intent.

.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;

Returns
Type	Description
boolean	Whether the intentInfo field is set.

hasPageInfo()

public abstract boolean hasPageInfo()

Information about page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;

Returns
Type	Description
boolean	Whether the pageInfo field is set.

hasPayload()

public abstract boolean hasPayload()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type	Description
boolean	Whether the payload field is set.

hasSentimentAnalysisResult()

public abstract boolean hasSentimentAnalysisResult()

The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;

Returns
Type	Description
boolean	Whether the sentimentAnalysisResult field is set.

hasSessionInfo()

public abstract boolean hasSessionInfo()

Information about session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;

Returns
Type	Description
boolean	Whether the sessionInfo field is set.

hasText()

public abstract boolean hasText()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 10;

Returns
Type	Description
boolean	Whether the text field is set.

hasTranscript()

public abstract boolean hasTranscript()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type	Description
boolean	Whether the transcript field is set.

hasTriggerEvent()

public abstract boolean hasTriggerEvent()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type	Description
boolean	Whether the triggerEvent field is set.

hasTriggerIntent()

public abstract boolean hasTriggerIntent()

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string trigger_intent = 11 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the triggerIntent field is set.