Package com.google.cloud.dialogflow.v2

Class Document

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.Document
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Document extends com.google.protobuf.GeneratedMessage implements DocumentOrBuilder
 A knowledge document to be used by a
 [KnowledgeBase][google.cloud.dialogflow.v2.KnowledgeBase].

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

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • MIME_TYPE_FIELD_NUMBER

      public static final int MIME_TYPE_FIELD_NUMBER
      See Also:

    • KNOWLEDGE_TYPES_FIELD_NUMBER

      public static final int KNOWLEDGE_TYPES_FIELD_NUMBER
      See Also:

    • CONTENT_URI_FIELD_NUMBER

      public static final int CONTENT_URI_FIELD_NUMBER
      See Also:

    • RAW_CONTENT_FIELD_NUMBER

      public static final int RAW_CONTENT_FIELD_NUMBER
      See Also:

    • ENABLE_AUTO_RELOAD_FIELD_NUMBER

      public static final int ENABLE_AUTO_RELOAD_FIELD_NUMBER
      See Also:

    • LATEST_RELOAD_STATUS_FIELD_NUMBER

      public static final int LATEST_RELOAD_STATUS_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSourceCase

      public Document.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface DocumentOrBuilder

    • getName

      public String getName()
       Optional. The document resource name.
 The name must be empty when creating a document.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
      string name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getName in interface DocumentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Optional. The document resource name.
 The name must be empty when creating a document.
 Format: `projects/<Project ID>/locations/<Location
 ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
      string name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNameBytes in interface DocumentOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The display name of the document. 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 DocumentOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the document. 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 DocumentOrBuilder
      Returns:
      The bytes for displayName.

    • getMimeType

      public String getMimeType()
       Required. The MIME type of this document.
      string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMimeType in interface DocumentOrBuilder
      Returns:
      The mimeType.

    • getMimeTypeBytes

      public com.google.protobuf.ByteString getMimeTypeBytes()
       Required. The MIME type of this document.
      string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMimeTypeBytes in interface DocumentOrBuilder
      Returns:
      The bytes for mimeType.

    • getKnowledgeTypesList

      public List<Document.KnowledgeType> getKnowledgeTypesList()
       Required. The knowledge type of document content.
      repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKnowledgeTypesList in interface DocumentOrBuilder
      Returns:
      A list containing the knowledgeTypes.

    • getKnowledgeTypesCount

      public int getKnowledgeTypesCount()
       Required. The knowledge type of document content.
      repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKnowledgeTypesCount in interface DocumentOrBuilder
      Returns:
      The count of knowledgeTypes.

    • getKnowledgeTypes

      public Document.KnowledgeType getKnowledgeTypes(int index)
       Required. The knowledge type of document content.
      repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKnowledgeTypes in interface DocumentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The knowledgeTypes at the given index.

    • getKnowledgeTypesValueList

      public List<Integer> getKnowledgeTypesValueList()
       Required. The knowledge type of document content.
      repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKnowledgeTypesValueList in interface DocumentOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for knowledgeTypes.

    • getKnowledgeTypesValue

      public int getKnowledgeTypesValue(int index)
       Required. The knowledge type of document content.
      repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKnowledgeTypesValue in interface DocumentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of knowledgeTypes at the given index.

    • hasContentUri

      public boolean hasContentUri()
       The URI where the file content is located.

 For documents stored in Google Cloud Storage, these URIs must have
 the form `gs://<bucket-name>/<object-name>`.

 NOTE: External URLs must correspond to public webpages, i.e., they must
 be indexed by Google Search. In particular, URLs for showing documents in
 Google Cloud Storage (i.e. the URL in your browser) are not supported.
 Instead use the `gs://` format URI described above.
      string content_uri = 5;
      Specified by:
      hasContentUri in interface DocumentOrBuilder
      Returns:
      Whether the contentUri field is set.

    • getContentUri

      public String getContentUri()
       The URI where the file content is located.

 For documents stored in Google Cloud Storage, these URIs must have
 the form `gs://<bucket-name>/<object-name>`.

 NOTE: External URLs must correspond to public webpages, i.e., they must
 be indexed by Google Search. In particular, URLs for showing documents in
 Google Cloud Storage (i.e. the URL in your browser) are not supported.
 Instead use the `gs://` format URI described above.
      string content_uri = 5;
      Specified by:
      getContentUri in interface DocumentOrBuilder
      Returns:
      The contentUri.

    • getContentUriBytes

      public com.google.protobuf.ByteString getContentUriBytes()
       The URI where the file content is located.

 For documents stored in Google Cloud Storage, these URIs must have
 the form `gs://<bucket-name>/<object-name>`.

 NOTE: External URLs must correspond to public webpages, i.e., they must
 be indexed by Google Search. In particular, URLs for showing documents in
 Google Cloud Storage (i.e. the URL in your browser) are not supported.
 Instead use the `gs://` format URI described above.
      string content_uri = 5;
      Specified by:
      getContentUriBytes in interface DocumentOrBuilder
      Returns:
      The bytes for contentUri.

    • hasRawContent

      public boolean hasRawContent()
       The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
      bytes raw_content = 9;
      Specified by:
      hasRawContent in interface DocumentOrBuilder
      Returns:
      Whether the rawContent field is set.

    • getRawContent

      public com.google.protobuf.ByteString getRawContent()
       The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
      bytes raw_content = 9;
      Specified by:
      getRawContent in interface DocumentOrBuilder
      Returns:
      The rawContent.

    • getEnableAutoReload

      public boolean getEnableAutoReload()
       Optional. If true, we try to automatically reload the document every day
 (at a time picked by the system). If false or unspecified, we don't try
 to automatically reload the document.

 Currently you can only enable automatic reload for documents sourced from
 a public url, see `source` field for the source types.

 Reload status can be tracked in `latest_reload_status`. If a reload
 fails, we will keep the document unchanged.

 If a reload fails with internal errors, the system will try to reload the
 document on the next day.
 If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the
 system will not try to reload the document anymore. You need to manually
 reload the document successfully by calling `ReloadDocument` and clear the
 errors.
      bool enable_auto_reload = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnableAutoReload in interface DocumentOrBuilder
      Returns:
      The enableAutoReload.

    • hasLatestReloadStatus

      public boolean hasLatestReloadStatus()
       Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
      .google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLatestReloadStatus in interface DocumentOrBuilder
      Returns:
      Whether the latestReloadStatus field is set.

    • getLatestReloadStatus

      public Document.ReloadStatus getLatestReloadStatus()
       Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
      .google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestReloadStatus in interface DocumentOrBuilder
      Returns:
      The latestReloadStatus.

    • getLatestReloadStatusOrBuilder

      public Document.ReloadStatusOrBuilder getLatestReloadStatusOrBuilder()
       Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
      .google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestReloadStatusOrBuilder in interface DocumentOrBuilder

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: DocumentOrBuilder
       Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
      map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataCount in interface DocumentOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
      map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsMetadata in interface DocumentOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface DocumentOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
      map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataMap in interface DocumentOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
       Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
      map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataOrDefault in interface DocumentOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
      map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataOrThrow in interface DocumentOrBuilder

    • getStateValue

      public int getStateValue()
       Output only. The current state of the document.
      .google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface DocumentOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Document.State getState()
       Output only. The current state of the document.
      .google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface DocumentOrBuilder
      Returns:
      The state.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Document parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Document.Builder newBuilder()

    • newBuilder

      public static Document.Builder newBuilder(Document prototype)

    • toBuilder

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

    • newBuilderForType

      protected Document.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Document> 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.GeneratedMessage

    • getDefaultInstanceForType

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