Class KnowledgeConnectorSettings.Builder (0.85.0) 

public static final class KnowledgeConnectorSettings.Builder extends GeneratedMessageV3.Builder<KnowledgeConnectorSettings.Builder> implements KnowledgeConnectorSettingsOrBuilder

The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.

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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllDataStoreConnections(Iterable<? extends DataStoreConnection> values)

public KnowledgeConnectorSettings.Builder addAllDataStoreConnections(Iterable<? extends DataStoreConnection> values)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.DataStoreConnection>
Returns
Type Description
KnowledgeConnectorSettings.Builder

addDataStoreConnections(DataStoreConnection value)

public KnowledgeConnectorSettings.Builder addDataStoreConnections(DataStoreConnection value)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataStoreConnection
Returns
Type Description
KnowledgeConnectorSettings.Builder

addDataStoreConnections(DataStoreConnection.Builder builderForValue)

public KnowledgeConnectorSettings.Builder addDataStoreConnections(DataStoreConnection.Builder builderForValue)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataStoreConnection.Builder
Returns
Type Description
KnowledgeConnectorSettings.Builder

addDataStoreConnections(int index, DataStoreConnection value)

public KnowledgeConnectorSettings.Builder addDataStoreConnections(int index, DataStoreConnection value)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DataStoreConnection
Returns
Type Description
KnowledgeConnectorSettings.Builder

addDataStoreConnections(int index, DataStoreConnection.Builder builderForValue)

public KnowledgeConnectorSettings.Builder addDataStoreConnections(int index, DataStoreConnection.Builder builderForValue)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DataStoreConnection.Builder
Returns
Type Description
KnowledgeConnectorSettings.Builder

addDataStoreConnectionsBuilder()

public DataStoreConnection.Builder addDataStoreConnectionsBuilder()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreConnection.Builder

addDataStoreConnectionsBuilder(int index)

public DataStoreConnection.Builder addDataStoreConnectionsBuilder(int index)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreConnection.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public KnowledgeConnectorSettings build()
Returns
Type Description
KnowledgeConnectorSettings

buildPartial()

public KnowledgeConnectorSettings buildPartial()
Returns
Type Description
KnowledgeConnectorSettings

clear()

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

clearDataStoreConnections()

public KnowledgeConnectorSettings.Builder clearDataStoreConnections()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
KnowledgeConnectorSettings.Builder

clearEnabled()

public KnowledgeConnectorSettings.Builder clearEnabled()

Whether Knowledge Connector is enabled or not.

bool enabled = 1;

Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTarget()

public KnowledgeConnectorSettings.Builder clearTarget()
Returns
Type Description
KnowledgeConnectorSettings.Builder

clearTargetFlow()

public KnowledgeConnectorSettings.Builder clearTargetFlow()

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

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

Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

clearTargetPage()

public KnowledgeConnectorSettings.Builder clearTargetPage()

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

clearTriggerFulfillment()

public KnowledgeConnectorSettings.Builder clearTriggerFulfillment()

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
KnowledgeConnectorSettings.Builder

clone()

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

getDataStoreConnections(int index)

public DataStoreConnection getDataStoreConnections(int index)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreConnection

getDataStoreConnectionsBuilder(int index)

public DataStoreConnection.Builder getDataStoreConnectionsBuilder(int index)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreConnection.Builder

getDataStoreConnectionsBuilderList()

public List<DataStoreConnection.Builder> getDataStoreConnectionsBuilderList()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getDataStoreConnectionsCount()

public int getDataStoreConnectionsCount()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDataStoreConnectionsList()

public List<DataStoreConnection> getDataStoreConnectionsList()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DataStoreConnection>

getDataStoreConnectionsOrBuilder(int index)

public DataStoreConnectionOrBuilder getDataStoreConnectionsOrBuilder(int index)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreConnectionOrBuilder

getDataStoreConnectionsOrBuilderList()

public List<? extends DataStoreConnectionOrBuilder> getDataStoreConnectionsOrBuilderList()

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

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

getDefaultInstanceForType()

public KnowledgeConnectorSettings getDefaultInstanceForType()
Returns
Type Description
KnowledgeConnectorSettings

getDescriptorForType()

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

getEnabled()

public boolean getEnabled()

Whether Knowledge Connector is enabled or not.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getTargetCase()

public KnowledgeConnectorSettings.TargetCase getTargetCase()
Returns
Type Description
KnowledgeConnectorSettings.TargetCase

getTargetFlow()

public String getTargetFlow()

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

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

Returns
Type Description
String

The targetFlow.

getTargetFlowBytes()

public ByteString getTargetFlowBytes()

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

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

Returns
Type Description
ByteString

The bytes for targetFlow.

getTargetPage()

public String getTargetPage()

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Returns
Type Description
String

The targetPage.

getTargetPageBytes()

public ByteString getTargetPageBytes()

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Returns
Type Description
ByteString

The bytes for targetPage.

getTriggerFulfillment()

public Fulfillment getTriggerFulfillment()

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
Fulfillment

The triggerFulfillment.

getTriggerFulfillmentBuilder()

public Fulfillment.Builder getTriggerFulfillmentBuilder()

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
Fulfillment.Builder

getTriggerFulfillmentOrBuilder()

public FulfillmentOrBuilder getTriggerFulfillmentOrBuilder()

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
FulfillmentOrBuilder

hasTargetFlow()

public boolean hasTargetFlow()

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string target_flow = 5 [(.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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Returns
Type Description
boolean

Whether the targetPage field is set.

hasTriggerFulfillment()

public boolean hasTriggerFulfillment()

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
boolean

Whether the triggerFulfillment field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(KnowledgeConnectorSettings other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeTriggerFulfillment(Fulfillment value)

public KnowledgeConnectorSettings.Builder mergeTriggerFulfillment(Fulfillment value)

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Parameter
Name Description
value Fulfillment
Returns
Type Description
KnowledgeConnectorSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeDataStoreConnections(int index)

public KnowledgeConnectorSettings.Builder removeDataStoreConnections(int index)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
KnowledgeConnectorSettings.Builder

setDataStoreConnections(int index, DataStoreConnection value)

public KnowledgeConnectorSettings.Builder setDataStoreConnections(int index, DataStoreConnection value)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DataStoreConnection
Returns
Type Description
KnowledgeConnectorSettings.Builder

setDataStoreConnections(int index, DataStoreConnection.Builder builderForValue)

public KnowledgeConnectorSettings.Builder setDataStoreConnections(int index, DataStoreConnection.Builder builderForValue)

Optional. List of related data store connections.

repeated .google.cloud.dialogflow.cx.v3.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DataStoreConnection.Builder
Returns
Type Description
KnowledgeConnectorSettings.Builder

setEnabled(boolean value)

public KnowledgeConnectorSettings.Builder setEnabled(boolean value)

Whether Knowledge Connector is enabled or not.

bool enabled = 1;

Parameter
Name Description
value boolean

The enabled to set.
Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setTargetFlow(String value)

public KnowledgeConnectorSettings.Builder setTargetFlow(String value)

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

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

Parameter
Name Description
value String

The targetFlow to set.
Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

setTargetFlowBytes(ByteString value)

public KnowledgeConnectorSettings.Builder setTargetFlowBytes(ByteString value)

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

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

Parameter
Name Description
value ByteString

The bytes for targetFlow to set.
Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

setTargetPage(String value)

public KnowledgeConnectorSettings.Builder setTargetPage(String value)

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Parameter
Name Description
value String

The targetPage to set.
Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

setTargetPageBytes(ByteString value)

public KnowledgeConnectorSettings.Builder setTargetPageBytes(ByteString value)

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

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

Parameter
Name Description
value ByteString

The bytes for targetPage to set.
Returns
Type Description
KnowledgeConnectorSettings.Builder

This builder for chaining.

setTriggerFulfillment(Fulfillment value)

public KnowledgeConnectorSettings.Builder setTriggerFulfillment(Fulfillment value)

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Parameter
Name Description
value Fulfillment
Returns
Type Description
KnowledgeConnectorSettings.Builder

setTriggerFulfillment(Fulfillment.Builder builderForValue)

public KnowledgeConnectorSettings.Builder setTriggerFulfillment(Fulfillment.Builder builderForValue)

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

.google.cloud.dialogflow.cx.v3.Fulfillment trigger_fulfillment = 3;

Parameter
Name Description
builderForValue Fulfillment.Builder
Returns
Type Description
KnowledgeConnectorSettings.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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