Package com.google.cloud.dialogflow.v2
Class Document.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
- com.google.cloud.dialogflow.v2.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.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 typegoogle.cloud.dialogflow.v2.Document
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Document.BuilderaddAllKnowledgeTypes(Iterable<? extends Document.KnowledgeType> values)Required.Document.BuilderaddAllKnowledgeTypesValue(Iterable<Integer> values)Required.Document.BuilderaddKnowledgeTypes(Document.KnowledgeType value)Required.Document.BuilderaddKnowledgeTypesValue(int value)Required.Document.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)Documentbuild()DocumentbuildPartial()Document.Builderclear()Document.BuilderclearContentUri()The URI where the file content is located.Document.BuilderclearDisplayName()Required.Document.BuilderclearEnableAutoReload()Optional.Document.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)Document.BuilderclearKnowledgeTypes()Required.Document.BuilderclearLatestReloadStatus()Output only.Document.BuilderclearMetadata()Document.BuilderclearMimeType()Required.Document.BuilderclearName()Optional.Document.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)Document.BuilderclearRawContent()The raw content of the document.Document.BuilderclearSource()Document.BuilderclearState()Output only.Document.Builderclone()booleancontainsMetadata(String key)Optional.StringgetContentUri()The URI where the file content is located.com.google.protobuf.ByteStringgetContentUriBytes()The URI where the file content is located.DocumentgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetDisplayName()Required.com.google.protobuf.ByteStringgetDisplayNameBytes()Required.booleangetEnableAutoReload()Optional.Document.KnowledgeTypegetKnowledgeTypes(int index)Required.intgetKnowledgeTypesCount()Required.List<Document.KnowledgeType>getKnowledgeTypesList()Required.intgetKnowledgeTypesValue(int index)Required.List<Integer>getKnowledgeTypesValueList()Required.Document.ReloadStatusgetLatestReloadStatus()Output only.Document.ReloadStatus.BuildergetLatestReloadStatusBuilder()Output only.Document.ReloadStatusOrBuildergetLatestReloadStatusOrBuilder()Output only.Map<String,String>getMetadata()Deprecated.intgetMetadataCount()Optional.Map<String,String>getMetadataMap()Optional.StringgetMetadataOrDefault(String key, String defaultValue)Optional.StringgetMetadataOrThrow(String key)Optional.StringgetMimeType()Required.com.google.protobuf.ByteStringgetMimeTypeBytes()Required.Map<String,String>getMutableMetadata()Deprecated.StringgetName()Optional.com.google.protobuf.ByteStringgetNameBytes()Optional.com.google.protobuf.ByteStringgetRawContent()The raw content of the document.Document.SourceCasegetSourceCase()Document.StategetState()Output only.intgetStateValue()Output only.booleanhasContentUri()The URI where the file content is located.booleanhasLatestReloadStatus()Output only.booleanhasRawContent()The raw content of the document.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)protected com.google.protobuf.MapFieldinternalGetMutableMapField(int number)booleanisInitialized()Document.BuildermergeFrom(Document other)Document.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)Document.BuildermergeFrom(com.google.protobuf.Message other)Document.BuildermergeLatestReloadStatus(Document.ReloadStatus value)Output only.Document.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)Document.BuilderputAllMetadata(Map<String,String> values)Optional.Document.BuilderputMetadata(String key, String value)Optional.Document.BuilderremoveMetadata(String key)Optional.Document.BuildersetContentUri(String value)The URI where the file content is located.Document.BuildersetContentUriBytes(com.google.protobuf.ByteString value)The URI where the file content is located.Document.BuildersetDisplayName(String value)Required.Document.BuildersetDisplayNameBytes(com.google.protobuf.ByteString value)Required.Document.BuildersetEnableAutoReload(boolean value)Optional.Document.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)Document.BuildersetKnowledgeTypes(int index, Document.KnowledgeType value)Required.Document.BuildersetKnowledgeTypesValue(int index, int value)Required.Document.BuildersetLatestReloadStatus(Document.ReloadStatus value)Output only.Document.BuildersetLatestReloadStatus(Document.ReloadStatus.Builder builderForValue)Output only.Document.BuildersetMimeType(String value)Required.Document.BuildersetMimeTypeBytes(com.google.protobuf.ByteString value)Required.Document.BuildersetName(String value)Optional.Document.BuildersetNameBytes(com.google.protobuf.ByteString value)Optional.Document.BuildersetRawContent(com.google.protobuf.ByteString value)The raw content of the document.Document.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)Document.BuildersetState(Document.State value)Output only.Document.BuildersetStateValue(int value)Output only.Document.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
clear
public Document.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
getDefaultInstanceForType
public Document getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public Document build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Document buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Document.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
setField
public Document.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
clearField
public Document.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
clearOneof
public Document.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
setRepeatedField
public Document.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
addRepeatedField
public Document.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
mergeFrom
public Document.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Document.Builder>
-
mergeFrom
public Document.Builder mergeFrom(Document other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Document.Builder>- Throws:
IOException
-
getSourceCase
public Document.SourceCase getSourceCase()
- Specified by:
getSourceCasein interfaceDocumentOrBuilder
-
clearSource
public Document.Builder clearSource()
-
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:
getNamein interfaceDocumentOrBuilder- 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:
getNameBytesin interfaceDocumentOrBuilder- 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:
getDisplayNamein interfaceDocumentOrBuilder- 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:
getDisplayNameBytesin interfaceDocumentOrBuilder- 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:
getMimeTypein interfaceDocumentOrBuilder- 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:
getMimeTypeBytesin interfaceDocumentOrBuilder- 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.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getKnowledgeTypesListin interfaceDocumentOrBuilder- 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:
getKnowledgeTypesCountin interfaceDocumentOrBuilder- 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:
getKnowledgeTypesin interfaceDocumentOrBuilder- 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.v2.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.v2.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.v2.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.v2.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.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getKnowledgeTypesValueListin interfaceDocumentOrBuilder- 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:
getKnowledgeTypesValuein interfaceDocumentOrBuilder- 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.v2.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.v2.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.v2.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:
hasContentUriin interfaceDocumentOrBuilder- 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:
getContentUriin interfaceDocumentOrBuilder- 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:
getContentUriBytesin interfaceDocumentOrBuilder- 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.
-
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:
hasRawContentin interfaceDocumentOrBuilder- 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:
getRawContentin interfaceDocumentOrBuilder- 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:
getEnableAutoReloadin interfaceDocumentOrBuilder- 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.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasLatestReloadStatusin interfaceDocumentOrBuilder- 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:
getLatestReloadStatusin interfaceDocumentOrBuilder- 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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLatestReloadStatusOrBuilderin interfaceDocumentOrBuilder
-
getMetadataCount
public int getMetadataCount()
Description copied from interface:DocumentOrBuilderOptional. 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:
getMetadataCountin interfaceDocumentOrBuilder
-
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:
containsMetadatain interfaceDocumentOrBuilder
-
getMetadata
@Deprecated public Map<String,String> getMetadata()
Deprecated.UsegetMetadataMap()instead.- Specified by:
getMetadatain interfaceDocumentOrBuilder
-
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:
getMetadataMapin interfaceDocumentOrBuilder
-
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:
getMetadataOrDefaultin interfaceDocumentOrBuilder
-
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:
getMetadataOrThrowin interfaceDocumentOrBuilder
-
clearMetadata
public Document.Builder clearMetadata()
-
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.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceDocumentOrBuilder- 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.v2.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.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceDocumentOrBuilder- Returns:
- The state.
-
setState
public Document.Builder setState(Document.State value)
Output only. The current state of the document.
.google.cloud.dialogflow.v2.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.v2.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:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
mergeUnknownFields
public final Document.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>
-
-