Package com.google.cloud.dialogflow.v2beta1

Class Document.Builder

  • All Implemented Interfaces:
    DocumentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Document
    public static final class Document.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
implements DocumentOrBuilder
     A knowledge document to be used by a
 [KnowledgeBase][google.cloud.dialogflow.v2beta1.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.v2beta1.Document

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • clear

        public Document.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Document.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • setField

        public Document.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • clearField

        public Document.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • clearOneof

        public Document.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • setRepeatedField

        public Document.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • addRepeatedField

        public Document.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • mergeFrom

        public Document.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • mergeFrom

        public Document.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
        Throws:
        IOException

      • 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.

      • setName

        public Document.Builder setName​(String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Document.Builder clearName()
         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:
        This builder for chaining.

      • setNameBytes

        public Document.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDisplayName

        public Document.Builder setDisplayName​(String value)
         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];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Document.Builder clearDisplayName()
         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:
        This builder for chaining.

      • setDisplayNameBytes

        public Document.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setMimeType

        public Document.Builder setMimeType​(String value)
         Required. The MIME type of this document.
        string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The mimeType to set.
        Returns:
        This builder for chaining.

      • clearMimeType

        public Document.Builder clearMimeType()
         Required. The MIME type of this document.
        string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setMimeTypeBytes

        public Document.Builder setMimeTypeBytes​(com.google.protobuf.ByteString value)
         Required. The MIME type of this document.
        string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for mimeType to set.
        Returns:
        This builder for chaining.

      • getKnowledgeTypesList

        public List<Document.KnowledgeType> getKnowledgeTypesList()
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.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.v2beta1.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.v2beta1.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.

      • setKnowledgeTypes

        public Document.Builder setKnowledgeTypes​(int index,
                                          Document.KnowledgeType value)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The knowledgeTypes to set.
        Returns:
        This builder for chaining.

      • addKnowledgeTypes

        public Document.Builder addKnowledgeTypes​(Document.KnowledgeType value)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The knowledgeTypes to add.
        Returns:
        This builder for chaining.

      • addAllKnowledgeTypes

        public Document.Builder addAllKnowledgeTypes​(Iterable<? extends Document.KnowledgeType> values)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The knowledgeTypes to add.
        Returns:
        This builder for chaining.

      • clearKnowledgeTypes

        public Document.Builder clearKnowledgeTypes()
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • getKnowledgeTypesValueList

        public List<Integer> getKnowledgeTypesValueList()
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.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.v2beta1.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.

      • setKnowledgeTypesValue

        public Document.Builder setKnowledgeTypesValue​(int index,
                                               int value)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The enum numeric value on the wire for knowledgeTypes to set.
        Returns:
        This builder for chaining.

      • addKnowledgeTypesValue

        public Document.Builder addKnowledgeTypesValue​(int value)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The enum numeric value on the wire for knowledgeTypes to add.
        Returns:
        This builder for chaining.

      • addAllKnowledgeTypesValue

        public Document.Builder addAllKnowledgeTypesValue​(Iterable<Integer> values)
         Required. The knowledge type of document content.
        repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The enum numeric values on the wire for knowledgeTypes to add.
        Returns:
        This builder for chaining.

      • 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.

      • setContentUri

        public Document.Builder setContentUri​(String value)
         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;
        Parameters:
        value - The contentUri to set.
        Returns:
        This builder for chaining.

      • clearContentUri

        public Document.Builder clearContentUri()
         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:
        This builder for chaining.

      • setContentUriBytes

        public Document.Builder setContentUriBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for contentUri to set.
        Returns:
        This builder for chaining.

      • hasContent

        @Deprecated
public boolean hasContent()
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Specified by:
        hasContent in interface DocumentOrBuilder
        Returns:
        Whether the content field is set.

      • getContent

        @Deprecated
public String getContent()
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Specified by:
        getContent in interface DocumentOrBuilder
        Returns:
        The content.

      • getContentBytes

        @Deprecated
public com.google.protobuf.ByteString getContentBytes()
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Specified by:
        getContentBytes in interface DocumentOrBuilder
        Returns:
        The bytes for content.

      • setContent

        @Deprecated
public Document.Builder setContent​(String value)
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Parameters:
        value - The content to set.
        Returns:
        This builder for chaining.

      • clearContent

        @Deprecated
public Document.Builder clearContent()
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Returns:
        This builder for chaining.

      • setContentBytes

        @Deprecated
public Document.Builder setContentBytes​(com.google.protobuf.ByteString value)
        Deprecated.
        google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
        string content = 6 [deprecated = true];
        Parameters:
        value - The bytes for content to set.
        Returns:
        This builder for chaining.

      • 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.

      • setRawContent

        public Document.Builder setRawContent​(com.google.protobuf.ByteString value)
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
        bytes raw_content = 9;
        Parameters:
        value - The rawContent to set.
        Returns:
        This builder for chaining.

      • clearRawContent

        public Document.Builder clearRawContent()
         The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
        bytes raw_content = 9;
        Returns:
        This builder for chaining.

      • 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.

      • setEnableAutoReload

        public Document.Builder setEnableAutoReload​(boolean value)
         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];
        Parameters:
        value - The enableAutoReload to set.
        Returns:
        This builder for chaining.

      • clearEnableAutoReload

        public Document.Builder clearEnableAutoReload()
         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:
        This builder for chaining.

      • 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.v2beta1.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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLatestReloadStatus in interface DocumentOrBuilder
        Returns:
        The latestReloadStatus.

      • setLatestReloadStatus

        public Document.Builder setLatestReloadStatus​(Document.ReloadStatus value)
         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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setLatestReloadStatus

        public Document.Builder setLatestReloadStatus​(Document.ReloadStatus.Builder builderForValue)
         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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeLatestReloadStatus

        public Document.Builder mergeLatestReloadStatus​(Document.ReloadStatus value)
         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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearLatestReloadStatus

        public Document.Builder clearLatestReloadStatus()
         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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLatestReloadStatusBuilder

        public Document.ReloadStatus.Builder getLatestReloadStatusBuilder()
         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.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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.v2beta1.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

      • 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

      • removeMetadata

        public Document.Builder removeMetadata​(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];

      • getMutableMetadata

        @Deprecated
public Map<String,​String> getMutableMetadata()
        Deprecated.
        Use alternate mutation accessors instead.

      • putMetadata

        public Document.Builder putMetadata​(String key,
                                    String value)
         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];

      • putAllMetadata

        public Document.Builder putAllMetadata​(Map<String,​String> values)
         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

        public int getStateValue()
         Output only. The current state of the document.
        .google.cloud.dialogflow.v2beta1.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.

      • setStateValue

        public Document.Builder setStateValue​(int value)
         Output only. The current state of the document.
        .google.cloud.dialogflow.v2beta1.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.

      • getState

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

      • setState

        public Document.Builder setState​(Document.State value)
         Output only. The current state of the document.
        .google.cloud.dialogflow.v2beta1.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.

      • clearState

        public Document.Builder clearState()
         Output only. The current state of the document.
        .google.cloud.dialogflow.v2beta1.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Document.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

      • mergeUnknownFields

        public final Document.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>