Package com.google.cloud.dialogflow.v2

Interface DocumentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Document, Document.Builder
    public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getDisplayName

        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];
        Returns:
        The displayName.

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • getMimeType

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

      • getMimeTypeBytes

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

      • getKnowledgeTypesList

        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];
        Returns:
        A list containing the knowledgeTypes.

      • getKnowledgeTypesCount

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

      • getKnowledgeTypes

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The knowledgeTypes at the given index.

      • getKnowledgeTypesValueList

        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];
        Returns:
        A list containing the enum numeric values on the wire for knowledgeTypes.

      • getKnowledgeTypesValue

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of knowledgeTypes at the given index.

      • hasContentUri

        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;
        Returns:
        Whether the contentUri field is set.

      • getContentUri

        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;
        Returns:
        The contentUri.

      • getContentUriBytes

        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;
        Returns:
        The bytes for contentUri.

      • hasRawContent

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

      • getRawContent

        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;
        Returns:
        The rawContent.

      • getEnableAutoReload

        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];
        Returns:
        The enableAutoReload.

      • hasLatestReloadStatus

        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];
        Returns:
        Whether the latestReloadStatus field is set.

      • getLatestReloadStatus

        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];
        Returns:
        The latestReloadStatus.

      • getLatestReloadStatusOrBuilder

        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];

      • getMetadataCount

        int getMetadataCount()
         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];

      • containsMetadata

        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];

      • getMetadataMap

        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];

      • getMetadataOrDefault

        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];

      • getMetadataOrThrow

        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];

      • getStateValue

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

      • getState

        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];
        Returns:
        The state.