Class WebhookRequest.Builder (0.29.0) 

public static final class WebhookRequest.Builder extends GeneratedMessageV3.Builder<WebhookRequest.Builder> implements WebhookRequestOrBuilder

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.

Protobuf type google.cloud.dialogflow.cx.v3.WebhookRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WebhookRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMessages(Iterable<? extends ResponseMessage> values)

public WebhookRequest.Builder addAllMessages(Iterable<? extends ResponseMessage> values)

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
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.ResponseMessage>
Returns
Type Description
WebhookRequest.Builder

addMessages(ResponseMessage value)

public WebhookRequest.Builder addMessages(ResponseMessage value)

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
value ResponseMessage
Returns
Type Description
WebhookRequest.Builder

addMessages(ResponseMessage.Builder builderForValue)

public WebhookRequest.Builder addMessages(ResponseMessage.Builder builderForValue)

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
builderForValue ResponseMessage.Builder
Returns
Type Description
WebhookRequest.Builder

addMessages(int index, ResponseMessage value)

public WebhookRequest.Builder addMessages(int index, ResponseMessage value)

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;

Parameters
Name Description
index int
value ResponseMessage
Returns
Type Description
WebhookRequest.Builder

addMessages(int index, ResponseMessage.Builder builderForValue)

public WebhookRequest.Builder addMessages(int index, ResponseMessage.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ResponseMessage.Builder
Returns
Type Description
WebhookRequest.Builder

addMessagesBuilder()

public ResponseMessage.Builder addMessagesBuilder()

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
ResponseMessage.Builder

addMessagesBuilder(int index)

public ResponseMessage.Builder addMessagesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WebhookRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WebhookRequest.Builder
Overrides

build()

public WebhookRequest build()
Returns
Type Description
WebhookRequest

buildPartial()

public WebhookRequest buildPartial()
Returns
Type Description
WebhookRequest

clear()

public WebhookRequest.Builder clear()
Returns
Type Description
WebhookRequest.Builder
Overrides

clearDetectIntentResponseId()

public WebhookRequest.Builder clearDetectIntentResponseId()

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
WebhookRequest.Builder

This builder for chaining.

clearDtmfDigits()

public WebhookRequest.Builder clearDtmfDigits()

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WebhookRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WebhookRequest.Builder
Overrides

clearFulfillmentInfo()

public WebhookRequest.Builder clearFulfillmentInfo()

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.Builder

clearIntentInfo()

public WebhookRequest.Builder clearIntentInfo()

Information about the last matched intent.

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

Returns
Type Description
WebhookRequest.Builder

clearLanguageCode()

public WebhookRequest.Builder clearLanguageCode()

The language code specified in the original request.

string language_code = 15;

Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

clearMessages()

public WebhookRequest.Builder clearMessages()

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
WebhookRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public WebhookRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WebhookRequest.Builder
Overrides

clearPageInfo()

public WebhookRequest.Builder clearPageInfo()

Information about page status.

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

Returns
Type Description
WebhookRequest.Builder

clearPayload()

public WebhookRequest.Builder clearPayload()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type Description
WebhookRequest.Builder

clearQuery()

public WebhookRequest.Builder clearQuery()
Returns
Type Description
WebhookRequest.Builder

clearSentimentAnalysisResult()

public WebhookRequest.Builder clearSentimentAnalysisResult()

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.Builder

clearSessionInfo()

public WebhookRequest.Builder clearSessionInfo()

Information about session status.

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

Returns
Type Description
WebhookRequest.Builder

clearText()

public WebhookRequest.Builder clearText()

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

string text = 10;

Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

clearTranscript()

public WebhookRequest.Builder clearTranscript()

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

string transcript = 12;

Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

clearTriggerEvent()

public WebhookRequest.Builder clearTriggerEvent()

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

string trigger_event = 14;

Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

clearTriggerIntent()

public WebhookRequest.Builder clearTriggerIntent()

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
WebhookRequest.Builder

This builder for chaining.

clone()

public WebhookRequest.Builder clone()
Returns
Type Description
WebhookRequest.Builder
Overrides

getDefaultInstanceForType()

public WebhookRequest getDefaultInstanceForType()
Returns
Type Description
WebhookRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetectIntentResponseId()

public 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 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.

getDtmfDigits()

public String getDtmfDigits()

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Returns
Type Description
String

The dtmfDigits.

getDtmfDigitsBytes()

public ByteString getDtmfDigitsBytes()

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Returns
Type Description
ByteString

The bytes for dtmfDigits.

getFulfillmentInfo()

public 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.

getFulfillmentInfoBuilder()

public WebhookRequest.FulfillmentInfo.Builder getFulfillmentInfoBuilder()

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.Builder

getFulfillmentInfoOrBuilder()

public 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 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.

getIntentInfoBuilder()

public WebhookRequest.IntentInfo.Builder getIntentInfoBuilder()

Information about the last matched intent.

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

Returns
Type Description
WebhookRequest.IntentInfo.Builder

getIntentInfoOrBuilder()

public 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 String getLanguageCode()

The language code specified in the original request.

string language_code = 15;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public 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 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

getMessagesBuilder(int index)

public ResponseMessage.Builder getMessagesBuilder(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.Builder

getMessagesBuilderList()

public List<ResponseMessage.Builder> getMessagesBuilderList()

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<Builder>

getMessagesCount()

public 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 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 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 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 PageInfo getPageInfo()

Information about page status.

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

Returns
Type Description
PageInfo

The pageInfo.

getPageInfoBuilder()

public PageInfo.Builder getPageInfoBuilder()

Information about page status.

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

Returns
Type Description
PageInfo.Builder

getPageInfoOrBuilder()

public PageInfoOrBuilder getPageInfoOrBuilder()

Information about page status.

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

Returns
Type Description
PageInfoOrBuilder

getPayload()

public Struct getPayload()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type Description
Struct

The payload.

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type Description
Builder

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Returns
Type Description
StructOrBuilder

getQueryCase()

public WebhookRequest.QueryCase getQueryCase()
Returns
Type Description
WebhookRequest.QueryCase

getSentimentAnalysisResult()

public 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.

getSentimentAnalysisResultBuilder()

public WebhookRequest.SentimentAnalysisResult.Builder getSentimentAnalysisResultBuilder()

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.Builder

getSentimentAnalysisResultOrBuilder()

public 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 SessionInfo getSessionInfo()

Information about session status.

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

Returns
Type Description
SessionInfo

The sessionInfo.

getSessionInfoBuilder()

public SessionInfo.Builder getSessionInfoBuilder()

Information about session status.

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

Returns
Type Description
SessionInfo.Builder

getSessionInfoOrBuilder()

public SessionInfoOrBuilder getSessionInfoOrBuilder()

Information about session status.

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

Returns
Type Description
SessionInfoOrBuilder

getText()

public 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 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 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 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 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 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 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 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.

hasDtmfDigits()

public boolean hasDtmfDigits()

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Returns
Type Description
boolean

Whether the dtmfDigits field is set.

hasFulfillmentInfo()

public 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WebhookRequest other)

public WebhookRequest.Builder mergeFrom(WebhookRequest other)
Parameter
Name Description
other WebhookRequest
Returns
Type Description
WebhookRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WebhookRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WebhookRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WebhookRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WebhookRequest.Builder
Overrides

mergeFulfillmentInfo(WebhookRequest.FulfillmentInfo value)

public WebhookRequest.Builder mergeFulfillmentInfo(WebhookRequest.FulfillmentInfo value)

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

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

Parameter
Name Description
value WebhookRequest.FulfillmentInfo
Returns
Type Description
WebhookRequest.Builder

mergeIntentInfo(WebhookRequest.IntentInfo value)

public WebhookRequest.Builder mergeIntentInfo(WebhookRequest.IntentInfo value)

Information about the last matched intent.

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

Parameter
Name Description
value WebhookRequest.IntentInfo
Returns
Type Description
WebhookRequest.Builder

mergePageInfo(PageInfo value)

public WebhookRequest.Builder mergePageInfo(PageInfo value)

Information about page status.

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

Parameter
Name Description
value PageInfo
Returns
Type Description
WebhookRequest.Builder

mergePayload(Struct value)

public WebhookRequest.Builder mergePayload(Struct value)

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Parameter
Name Description
value Struct
Returns
Type Description
WebhookRequest.Builder

mergeSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult value)

public WebhookRequest.Builder mergeSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult value)

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;

Parameter
Name Description
value WebhookRequest.SentimentAnalysisResult
Returns
Type Description
WebhookRequest.Builder

mergeSessionInfo(SessionInfo value)

public WebhookRequest.Builder mergeSessionInfo(SessionInfo value)

Information about session status.

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

Parameter
Name Description
value SessionInfo
Returns
Type Description
WebhookRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WebhookRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WebhookRequest.Builder
Overrides

removeMessages(int index)

public WebhookRequest.Builder removeMessages(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
WebhookRequest.Builder

setDetectIntentResponseId(String value)

public WebhookRequest.Builder setDetectIntentResponseId(String value)

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

string detect_intent_response_id = 1;

Parameter
Name Description
value String

The detectIntentResponseId to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setDetectIntentResponseIdBytes(ByteString value)

public WebhookRequest.Builder setDetectIntentResponseIdBytes(ByteString value)

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

string detect_intent_response_id = 1;

Parameter
Name Description
value ByteString

The bytes for detectIntentResponseId to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setDtmfDigits(String value)

public WebhookRequest.Builder setDtmfDigits(String value)

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Parameter
Name Description
value String

The dtmfDigits to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setDtmfDigitsBytes(ByteString value)

public WebhookRequest.Builder setDtmfDigitsBytes(ByteString value)

If DTMF was provided as input, this field will contain the DTMF digits.

string dtmf_digits = 17;

Parameter
Name Description
value ByteString

The bytes for dtmfDigits to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WebhookRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WebhookRequest.Builder
Overrides

setFulfillmentInfo(WebhookRequest.FulfillmentInfo value)

public WebhookRequest.Builder setFulfillmentInfo(WebhookRequest.FulfillmentInfo value)

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

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

Parameter
Name Description
value WebhookRequest.FulfillmentInfo
Returns
Type Description
WebhookRequest.Builder

setFulfillmentInfo(WebhookRequest.FulfillmentInfo.Builder builderForValue)

public WebhookRequest.Builder setFulfillmentInfo(WebhookRequest.FulfillmentInfo.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue WebhookRequest.FulfillmentInfo.Builder
Returns
Type Description
WebhookRequest.Builder

setIntentInfo(WebhookRequest.IntentInfo value)

public WebhookRequest.Builder setIntentInfo(WebhookRequest.IntentInfo value)

Information about the last matched intent.

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

Parameter
Name Description
value WebhookRequest.IntentInfo
Returns
Type Description
WebhookRequest.Builder

setIntentInfo(WebhookRequest.IntentInfo.Builder builderForValue)

public WebhookRequest.Builder setIntentInfo(WebhookRequest.IntentInfo.Builder builderForValue)

Information about the last matched intent.

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

Parameter
Name Description
builderForValue WebhookRequest.IntentInfo.Builder
Returns
Type Description
WebhookRequest.Builder

setLanguageCode(String value)

public WebhookRequest.Builder setLanguageCode(String value)

The language code specified in the original request.

string language_code = 15;

Parameter
Name Description
value String

The languageCode to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public WebhookRequest.Builder setLanguageCodeBytes(ByteString value)

The language code specified in the original request.

string language_code = 15;

Parameter
Name Description
value ByteString

The bytes for languageCode to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setMessages(int index, ResponseMessage value)

public WebhookRequest.Builder setMessages(int index, ResponseMessage value)

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;

Parameters
Name Description
index int
value ResponseMessage
Returns
Type Description
WebhookRequest.Builder

setMessages(int index, ResponseMessage.Builder builderForValue)

public WebhookRequest.Builder setMessages(int index, ResponseMessage.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ResponseMessage.Builder
Returns
Type Description
WebhookRequest.Builder

setPageInfo(PageInfo value)

public WebhookRequest.Builder setPageInfo(PageInfo value)

Information about page status.

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

Parameter
Name Description
value PageInfo
Returns
Type Description
WebhookRequest.Builder

setPageInfo(PageInfo.Builder builderForValue)

public WebhookRequest.Builder setPageInfo(PageInfo.Builder builderForValue)

Information about page status.

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

Parameter
Name Description
builderForValue PageInfo.Builder
Returns
Type Description
WebhookRequest.Builder

setPayload(Struct value)

public WebhookRequest.Builder setPayload(Struct value)

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Parameter
Name Description
value Struct
Returns
Type Description
WebhookRequest.Builder

setPayload(Struct.Builder builderForValue)

public WebhookRequest.Builder setPayload(Struct.Builder builderForValue)

Custom data set in QueryParameters.payload.

.google.protobuf.Struct payload = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
WebhookRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WebhookRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WebhookRequest.Builder
Overrides

setSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult value)

public WebhookRequest.Builder setSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult value)

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;

Parameter
Name Description
value WebhookRequest.SentimentAnalysisResult
Returns
Type Description
WebhookRequest.Builder

setSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult.Builder builderForValue)

public WebhookRequest.Builder setSentimentAnalysisResult(WebhookRequest.SentimentAnalysisResult.Builder builderForValue)

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;

Parameter
Name Description
builderForValue WebhookRequest.SentimentAnalysisResult.Builder
Returns
Type Description
WebhookRequest.Builder

setSessionInfo(SessionInfo value)

public WebhookRequest.Builder setSessionInfo(SessionInfo value)

Information about session status.

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

Parameter
Name Description
value SessionInfo
Returns
Type Description
WebhookRequest.Builder

setSessionInfo(SessionInfo.Builder builderForValue)

public WebhookRequest.Builder setSessionInfo(SessionInfo.Builder builderForValue)

Information about session status.

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

Parameter
Name Description
builderForValue SessionInfo.Builder
Returns
Type Description
WebhookRequest.Builder

setText(String value)

public WebhookRequest.Builder setText(String value)

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

string text = 10;

Parameter
Name Description
value String

The text to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTextBytes(ByteString value)

public WebhookRequest.Builder setTextBytes(ByteString value)

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

string text = 10;

Parameter
Name Description
value ByteString

The bytes for text to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTranscript(String value)

public WebhookRequest.Builder setTranscript(String value)

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

string transcript = 12;

Parameter
Name Description
value String

The transcript to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTranscriptBytes(ByteString value)

public WebhookRequest.Builder setTranscriptBytes(ByteString value)

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

string transcript = 12;

Parameter
Name Description
value ByteString

The bytes for transcript to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTriggerEvent(String value)

public WebhookRequest.Builder setTriggerEvent(String value)

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

string trigger_event = 14;

Parameter
Name Description
value String

The triggerEvent to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTriggerEventBytes(ByteString value)

public WebhookRequest.Builder setTriggerEventBytes(ByteString value)

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

string trigger_event = 14;

Parameter
Name Description
value ByteString

The bytes for triggerEvent to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTriggerIntent(String value)

public WebhookRequest.Builder setTriggerIntent(String value)

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) = { ... }

Parameter
Name Description
value String

The triggerIntent to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setTriggerIntentBytes(ByteString value)

public WebhookRequest.Builder setTriggerIntentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for triggerIntent to set.
Returns
Type Description
WebhookRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WebhookRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WebhookRequest.Builder
Overrides