Class WebhookResponse.Builder (0.45.0)

public static final class WebhookResponse.Builder extends GeneratedMessageV3.Builder<WebhookResponse.Builder> implements WebhookResponseOrBuilder

The response message for a webhook call.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public WebhookResponse build()
Returns
Type Description
WebhookResponse

buildPartial()

public WebhookResponse buildPartial()
Returns
Type Description
WebhookResponse

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFulfillmentResponse()

public WebhookResponse.Builder clearFulfillmentResponse()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type Description
WebhookResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageInfo()

public WebhookResponse.Builder clearPageInfo()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Returns
Type Description
WebhookResponse.Builder

clearPayload()

public WebhookResponse.Builder clearPayload()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type Description
WebhookResponse.Builder

clearSessionInfo()

public WebhookResponse.Builder clearSessionInfo()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Returns
Type Description
WebhookResponse.Builder

clearTargetFlow()

public WebhookResponse.Builder clearTargetFlow()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

clearTargetPage()

public WebhookResponse.Builder clearTargetPage()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

clearTransition()

public WebhookResponse.Builder clearTransition()
Returns
Type Description
WebhookResponse.Builder

clone()

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

getDefaultInstanceForType()

public WebhookResponse getDefaultInstanceForType()
Returns
Type Description
WebhookResponse

getDescriptorForType()

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

getFulfillmentResponse()

public WebhookResponse.FulfillmentResponse getFulfillmentResponse()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type Description
WebhookResponse.FulfillmentResponse

The fulfillmentResponse.

getFulfillmentResponseBuilder()

public WebhookResponse.FulfillmentResponse.Builder getFulfillmentResponseBuilder()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type Description
WebhookResponse.FulfillmentResponse.Builder

getFulfillmentResponseOrBuilder()

public WebhookResponse.FulfillmentResponseOrBuilder getFulfillmentResponseOrBuilder()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type Description
WebhookResponse.FulfillmentResponseOrBuilder

getPageInfo()

public PageInfo getPageInfo()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Returns
Type Description
PageInfo

The pageInfo.

getPageInfoBuilder()

public PageInfo.Builder getPageInfoBuilder()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Returns
Type Description
PageInfo.Builder

getPageInfoOrBuilder()

public PageInfoOrBuilder getPageInfoOrBuilder()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Returns
Type Description
PageInfoOrBuilder

getPayload()

public Struct getPayload()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type Description
Struct

The payload.

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type Description
Builder

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type Description
StructOrBuilder

getSessionInfo()

public SessionInfo getSessionInfo()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Returns
Type Description
SessionInfo

The sessionInfo.

getSessionInfoBuilder()

public SessionInfo.Builder getSessionInfoBuilder()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Returns
Type Description
SessionInfo.Builder

getSessionInfoOrBuilder()

public SessionInfoOrBuilder getSessionInfoOrBuilder()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Returns
Type Description
SessionInfoOrBuilder

getTargetFlow()

public String getTargetFlow()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The targetFlow.

getTargetFlowBytes()

public ByteString getTargetFlowBytes()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for targetFlow.

getTargetPage()

public String getTargetPage()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The targetPage.

getTargetPageBytes()

public ByteString getTargetPageBytes()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for targetPage.

getTransitionCase()

public WebhookResponse.TransitionCase getTransitionCase()
Returns
Type Description
WebhookResponse.TransitionCase

hasFulfillmentResponse()

public boolean hasFulfillmentResponse()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type Description
boolean

Whether the fulfillmentResponse field is set.

hasPageInfo()

public boolean hasPageInfo()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Returns
Type Description
boolean

Whether the pageInfo field is set.

hasPayload()

public boolean hasPayload()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type Description
boolean

Whether the payload field is set.

hasSessionInfo()

public boolean hasSessionInfo()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Returns
Type Description
boolean

Whether the sessionInfo field is set.

hasTargetFlow()

public boolean hasTargetFlow()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the targetFlow field is set.

hasTargetPage()

public boolean hasTargetPage()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the targetPage field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WebhookResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFulfillmentResponse(WebhookResponse.FulfillmentResponse value)

public WebhookResponse.Builder mergeFulfillmentResponse(WebhookResponse.FulfillmentResponse value)

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Parameter
Name Description
value WebhookResponse.FulfillmentResponse
Returns
Type Description
WebhookResponse.Builder

mergePageInfo(PageInfo value)

public WebhookResponse.Builder mergePageInfo(PageInfo value)

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Parameter
Name Description
value PageInfo
Returns
Type Description
WebhookResponse.Builder

mergePayload(Struct value)

public WebhookResponse.Builder mergePayload(Struct value)

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Parameter
Name Description
value Struct
Returns
Type Description
WebhookResponse.Builder

mergeSessionInfo(SessionInfo value)

public WebhookResponse.Builder mergeSessionInfo(SessionInfo value)

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Parameter
Name Description
value SessionInfo
Returns
Type Description
WebhookResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFulfillmentResponse(WebhookResponse.FulfillmentResponse value)

public WebhookResponse.Builder setFulfillmentResponse(WebhookResponse.FulfillmentResponse value)

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Parameter
Name Description
value WebhookResponse.FulfillmentResponse
Returns
Type Description
WebhookResponse.Builder

setFulfillmentResponse(WebhookResponse.FulfillmentResponse.Builder builderForValue)

public WebhookResponse.Builder setFulfillmentResponse(WebhookResponse.FulfillmentResponse.Builder builderForValue)

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Parameter
Name Description
builderForValue WebhookResponse.FulfillmentResponse.Builder
Returns
Type Description
WebhookResponse.Builder

setPageInfo(PageInfo value)

public WebhookResponse.Builder setPageInfo(PageInfo value)

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

Parameter
Name Description
value PageInfo
Returns
Type Description
WebhookResponse.Builder

setPageInfo(PageInfo.Builder builderForValue)

public WebhookResponse.Builder setPageInfo(PageInfo.Builder builderForValue)

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

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

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

setPayload(Struct value)

public WebhookResponse.Builder setPayload(Struct value)

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Parameter
Name Description
value Struct
Returns
Type Description
WebhookResponse.Builder

setPayload(Struct.Builder builderForValue)

public WebhookResponse.Builder setPayload(Struct.Builder builderForValue)

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
WebhookResponse.Builder

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

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

setSessionInfo(SessionInfo value)

public WebhookResponse.Builder setSessionInfo(SessionInfo value)

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

Parameter
Name Description
value SessionInfo
Returns
Type Description
WebhookResponse.Builder

setSessionInfo(SessionInfo.Builder builderForValue)

public WebhookResponse.Builder setSessionInfo(SessionInfo.Builder builderForValue)

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

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

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

setTargetFlow(String value)

public WebhookResponse.Builder setTargetFlow(String value)

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The targetFlow to set.

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

setTargetFlowBytes(ByteString value)

public WebhookResponse.Builder setTargetFlowBytes(ByteString value)

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for targetFlow to set.

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

setTargetPage(String value)

public WebhookResponse.Builder setTargetPage(String value)

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The targetPage to set.

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

setTargetPageBytes(ByteString value)

public WebhookResponse.Builder setTargetPageBytes(ByteString value)

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for targetPage to set.

Returns
Type Description
WebhookResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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