Package com.google.cloud.dialogflow.v2

Class SearchKnowledgeRequest

  • All Implemented Interfaces:
    SearchKnowledgeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchKnowledgeRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchKnowledgeRequestOrBuilder
     The request message for
 [Conversations.SearchKnowledge][google.cloud.dialogflow.v2.Conversations.SearchKnowledge].
    Protobuf type google.cloud.dialogflow.v2.SearchKnowledgeRequest
    See Also:
    Serialized Form

    • 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

      • getParent

        public String getParent()
         The parent resource contains the conversation profile
 Format: 'projects/<Project ID>' or `projects/<Project
 ID>/locations/<Location ID>`.
        string parent = 6;
        Specified by:
        getParent in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         The parent resource contains the conversation profile
 Format: 'projects/<Project ID>' or `projects/<Project
 ID>/locations/<Location ID>`.
        string parent = 6;
        Specified by:
        getParentBytes in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasQuery

        public boolean hasQuery()
         Required. The natural language text query for knowledge search.
        .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasQuery in interface SearchKnowledgeRequestOrBuilder
        Returns:
        Whether the query field is set.

      • getQuery

        public TextInput getQuery()
         Required. The natural language text query for knowledge search.
        .google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The query.

      • getConversationProfile

        public String getConversationProfile()
         Required. The conversation profile used to configure the search.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversationProfile in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The conversationProfile.

      • getConversationProfileBytes

        public com.google.protobuf.ByteString getConversationProfileBytes()
         Required. The conversation profile used to configure the search.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversationProfiles/<Conversation Profile ID>`.
        string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getConversationProfileBytes in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The bytes for conversationProfile.

      • getSessionId

        public String getSessionId()
         The ID of the search session.
 The session_id can be combined with Dialogflow V3 Agent ID retrieved from
 conversation profile or on its own to identify a search session. The search
 history of the same session will impact the search result. It's up to the
 API caller to choose an appropriate `Session ID`. It can be a random number
 or some type of session identifiers (preferably hashed). The length must
 not exceed 36 characters.
        string session_id = 3;
        Specified by:
        getSessionId in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The sessionId.

      • getSessionIdBytes

        public com.google.protobuf.ByteString getSessionIdBytes()
         The ID of the search session.
 The session_id can be combined with Dialogflow V3 Agent ID retrieved from
 conversation profile or on its own to identify a search session. The search
 history of the same session will impact the search result. It's up to the
 API caller to choose an appropriate `Session ID`. It can be a random number
 or some type of session identifiers (preferably hashed). The length must
 not exceed 36 characters.
        string session_id = 3;
        Specified by:
        getSessionIdBytes in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The bytes for sessionId.

      • getConversation

        public String getConversation()
         The conversation (between human agent and end user) where the search
 request is triggered. Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>`.
        string conversation = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversation in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The conversation.

      • getConversationBytes

        public com.google.protobuf.ByteString getConversationBytes()
         The conversation (between human agent and end user) where the search
 request is triggered. Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>`.
        string conversation = 4 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversationBytes in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The bytes for conversation.

      • getLatestMessage

        public String getLatestMessage()
         The name of the latest conversation message when the request is
 triggered.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/messages/<Message ID>`.
        string latest_message = 5 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLatestMessage in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The latestMessage.

      • getLatestMessageBytes

        public com.google.protobuf.ByteString getLatestMessageBytes()
         The name of the latest conversation message when the request is
 triggered.
 Format: `projects/<Project ID>/locations/<Location
 ID>/conversations/<Conversation ID>/messages/<Message ID>`.
        string latest_message = 5 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLatestMessageBytes in interface SearchKnowledgeRequestOrBuilder
        Returns:
        The bytes for latestMessage.

      • 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 SearchKnowledgeRequest parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SearchKnowledgeRequest> 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 SearchKnowledgeRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder