Class KnowledgeConnectorSettings

  • All Implemented Interfaces:
    KnowledgeConnectorSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class KnowledgeConnectorSettings
    extends com.google.protobuf.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.v3beta1.KnowledgeConnectorSettings
    See Also:
    Serialized Form
    • Field Detail

      • TRIGGER_FULFILLMENT_FIELD_NUMBER

        public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TARGET_PAGE_FIELD_NUMBER

        public static final int TARGET_PAGE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TARGET_FLOW_FIELD_NUMBER

        public static final int TARGET_FLOW_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DATA_STORE_CONNECTIONS_FIELD_NUMBER

        public static final int DATA_STORE_CONNECTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.v3beta1.Fulfillment trigger_fulfillment = 3;
        Specified by:
        hasTriggerFulfillment in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        Whether the triggerFulfillment field is set.
      • 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.v3beta1.Fulfillment trigger_fulfillment = 3;
        Specified by:
        getTriggerFulfillment in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        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.v3beta1.Fulfillment trigger_fulfillment = 3;
        Specified by:
        getTriggerFulfillmentOrBuilder in interface KnowledgeConnectorSettingsOrBuilder
      • 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) = { ... }
        Specified by:
        hasTargetPage in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        Whether the targetPage field is set.
      • 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) = { ... }
        Specified by:
        getTargetPage in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        The targetPage.
      • getTargetPageBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetPageBytes in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        The bytes for targetPage.
      • 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) = { ... }
        Specified by:
        hasTargetFlow in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        Whether the targetFlow field is set.
      • 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) = { ... }
        Specified by:
        getTargetFlow in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        The targetFlow.
      • getTargetFlowBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetFlowBytes in interface KnowledgeConnectorSettingsOrBuilder
        Returns:
        The bytes for targetFlow.
      • getDataStoreConnectionsCount

        public int getDataStoreConnectionsCount()
         Optional. List of related data store connections.
         
        repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnection data_store_connections = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataStoreConnectionsCount in interface KnowledgeConnectorSettingsOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static KnowledgeConnectorSettings parseFrom​(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public KnowledgeConnectorSettings.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public KnowledgeConnectorSettings.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected KnowledgeConnectorSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<KnowledgeConnectorSettings> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public KnowledgeConnectorSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder