Class KnowledgeConnectorSettings (0.35.0)

public final class KnowledgeConnectorSettings extends GeneratedMessageV3 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

Static Fields

DATA_STORE_CONNECTIONS_FIELD_NUMBER

public static final int DATA_STORE_CONNECTIONS_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FLOW_FIELD_NUMBER

public static final int TARGET_FLOW_FIELD_NUMBER
Field Value
Type Description
int

TARGET_PAGE_FIELD_NUMBER

public static final int TARGET_PAGE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_FULFILLMENT_FIELD_NUMBER

public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KnowledgeConnectorSettings getDefaultInstance()
Returns
Type Description
KnowledgeConnectorSettings

getDescriptor()

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

newBuilder()

public static KnowledgeConnectorSettings.Builder newBuilder()
Returns
Type Description
KnowledgeConnectorSettings.Builder

newBuilder(KnowledgeConnectorSettings prototype)

public static KnowledgeConnectorSettings.Builder newBuilder(KnowledgeConnectorSettings prototype)
Parameter
Name Description
prototype KnowledgeConnectorSettings
Returns
Type Description
KnowledgeConnectorSettings.Builder

parseDelimitedFrom(InputStream input)

public static KnowledgeConnectorSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KnowledgeConnectorSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeConnectorSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeConnectorSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KnowledgeConnectorSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KnowledgeConnectorSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeConnectorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KnowledgeConnectorSettings> parser()
Returns
Type Description
Parser<KnowledgeConnectorSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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

getEnabled()

public boolean getEnabled()

Whether Knowledge Connector is enabled or not.

bool enabled = 1;

Returns
Type Description
boolean

The enabled.

getParserForType()

public Parser<KnowledgeConnectorSettings> getParserForType()
Returns
Type Description
Parser<KnowledgeConnectorSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetCase()

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

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 = 5 [(.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 = 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

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.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeConnectorSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KnowledgeConnectorSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException