Class KnowledgeConnectorSettings (0.52.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
TypeDescription
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_FLOW_FIELD_NUMBER

public static final int TARGET_FLOW_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_PAGE_FIELD_NUMBER

public static final int TARGET_PAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TRIGGER_FULFILLMENT_FIELD_NUMBER

public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static KnowledgeConnectorSettings getDefaultInstance()
Returns
TypeDescription
KnowledgeConnectorSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static KnowledgeConnectorSettings.Builder newBuilder()
Returns
TypeDescription
KnowledgeConnectorSettings.Builder

newBuilder(KnowledgeConnectorSettings prototype)

public static KnowledgeConnectorSettings.Builder newBuilder(KnowledgeConnectorSettings prototype)
Parameter
NameDescription
prototypeKnowledgeConnectorSettings
Returns
TypeDescription
KnowledgeConnectorSettings.Builder

parseDelimitedFrom(InputStream input)

public static KnowledgeConnectorSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static KnowledgeConnectorSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeConnectorSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeConnectorSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static KnowledgeConnectorSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static KnowledgeConnectorSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeConnectorSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeConnectorSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<KnowledgeConnectorSettings> parser()
Returns
TypeDescription
Parser<KnowledgeConnectorSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.dialogflow.cx.v3.DataStoreConnectionOrBuilder>

getDefaultInstanceForType()

public KnowledgeConnectorSettings getDefaultInstanceForType()
Returns
TypeDescription
KnowledgeConnectorSettings

getEnabled()

public boolean getEnabled()

Whether Knowledge Connector is enabled or not.

bool enabled = 1;

Returns
TypeDescription
boolean

The enabled.

getParserForType()

public Parser<KnowledgeConnectorSettings> getParserForType()
Returns
TypeDescription
Parser<KnowledgeConnectorSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetCase()

public KnowledgeConnectorSettings.TargetCase getTargetCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the triggerFulfillment field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public KnowledgeConnectorSettings.Builder newBuilderForType()
Returns
TypeDescription
KnowledgeConnectorSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeConnectorSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KnowledgeConnectorSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public KnowledgeConnectorSettings.Builder toBuilder()
Returns
TypeDescription
KnowledgeConnectorSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException