Package com.google.cloud.dialogflow.v2

Class KnowledgeBase

  • All Implemented Interfaces:
    KnowledgeBaseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class KnowledgeBase
extends com.google.protobuf.GeneratedMessageV3
implements KnowledgeBaseOrBuilder
     A knowledge base represents a collection of knowledge documents that you
 provide to Dialogflow. Your knowledge documents contain information that may
 be useful during conversations with end-users. Some Dialogflow features use
 knowledge bases when looking for a response to an end-user input.

 For more information, see the [knowledge base
 guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).

 Note: The `projects.agent.knowledgeBases` resource is deprecated;
 only use `projects.knowledgeBases`.
    Protobuf type google.cloud.dialogflow.v2.KnowledgeBase
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KnowledgeBase.Builder
      A knowledge base represents a collection of knowledge documents that you provide to Dialogflow.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DISPLAY_NAME_FIELD_NUMBER  
      static int LANGUAGE_CODE_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • 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

      • getName

        public String getName()
         The knowledge base resource name.
 The name must be empty when creating a knowledge base.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
        string name = 1;
        Specified by:
        getName in interface KnowledgeBaseOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The knowledge base resource name.
 The name must be empty when creating a knowledge base.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>`.
        string name = 1;
        Specified by:
        getNameBytes in interface KnowledgeBaseOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The display name of the knowledge base. The name must be 1024
 bytes or less; otherwise, the creation request fails.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface KnowledgeBaseOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The display name of the knowledge base. The name must be 1024
 bytes or less; otherwise, the creation request fails.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface KnowledgeBaseOrBuilder
        Returns:
        The bytes for displayName.

      • getLanguageCode

        public String getLanguageCode()
         Language which represents the KnowledgeBase. When the KnowledgeBase is
 created/updated, expect this to be present for non en-us languages. When
 unspecified, the default language code en-us applies.
        string language_code = 4;
        Specified by:
        getLanguageCode in interface KnowledgeBaseOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Language which represents the KnowledgeBase. When the KnowledgeBase is
 created/updated, expect this to be present for non en-us languages. When
 unspecified, the default language code en-us applies.
        string language_code = 4;
        Specified by:
        getLanguageCodeBytes in interface KnowledgeBaseOrBuilder
        Returns:
        The bytes for languageCode.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static KnowledgeBase parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static KnowledgeBase getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<KnowledgeBase> parser()

      • getParserForType

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