Class Document.Builder (4.57.0) 

public static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder

A knowledge document to be used by a KnowledgeBase.

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Protobuf type google.cloud.dialogflow.v2beta1.Document

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Builder

Implements

DocumentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllKnowledgeTypes(Iterable<? extends Document.KnowledgeType> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Document.KnowledgeType>

The knowledgeTypes to add.
Returns
Type Description
Document.Builder

This builder for chaining.

addAllKnowledgeTypesValue(Iterable<Integer> values)

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for knowledgeTypes to add.
Returns
Type Description
Document.Builder

This builder for chaining.

addKnowledgeTypes(Document.KnowledgeType value)

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

Parameter
Name Description
value Document.KnowledgeType

The knowledgeTypes to add.
Returns
Type Description
Document.Builder

This builder for chaining.

addKnowledgeTypesValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for knowledgeTypes to add.
Returns
Type Description
Document.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Builder
Overrides

build()

public Document build()
Returns
Type Description
Document

buildPartial()

public Document buildPartial()
Returns
Type Description
Document

clear()

public Document.Builder clear()
Returns
Type Description
Document.Builder
Overrides

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
Type Description
Document.Builder

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
Type Description
Document.Builder

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
Type Description
Document.Builder

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
Type Description
Document.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Builder
Overrides

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
Type Description
Document.Builder

This builder for chaining.

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

Returns
Type Description
Document.Builder

clearMetadata()

public Document.Builder clearMetadata()
Returns
Type Description
Document.Builder

clearMimeType()

public Document.Builder clearMimeType()

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Document.Builder

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
Type Description
Document.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Builder
Overrides

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
Type Description
Document.Builder

This builder for chaining.

clearSource()

public Document.Builder clearSource()
Returns
Type Description
Document.Builder

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
Type Description
Document.Builder

This builder for chaining.

clone()

public Document.Builder clone()
Returns
Type Description
Document.Builder
Overrides

containsMetadata(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

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

Returns
Type Description
String

The content.

getContentBytes() (deprecated)

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

Returns
Type Description
ByteString

The bytes for content.

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;

Returns
Type Description
String

The contentUri.

getContentUriBytes()

public 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
Type Description
ByteString

The bytes for contentUri.

getDefaultInstanceForType()

public Document getDefaultInstanceForType()
Returns
Type Description
Document

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public 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
Type Description
ByteString

The bytes for displayName.

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

Returns
Type Description
boolean

The enableAutoReload.

getKnowledgeTypes(int index)

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Document.KnowledgeType

The knowledgeTypes at the given index.

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

Returns
Type Description
int

The count of knowledgeTypes.

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

Returns
Type Description
List<KnowledgeType>

A list containing the knowledgeTypes.

getKnowledgeTypesValue(int index)

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of knowledgeTypes at the given index.

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

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for knowledgeTypes.

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

Returns
Type Description
Document.ReloadStatus

The latestReloadStatus.

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

Returns
Type Description
Document.ReloadStatus.Builder

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

Returns
Type Description
Document.ReloadStatusOrBuilder

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getMimeType()

public String getMimeType()

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for mimeType.

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

Returns
Type Description
String

The name.

getNameBytes()

public 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
Type Description
ByteString

The bytes for name.

getRawContent()

public 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
Type Description
ByteString

The rawContent.

getSourceCase()

public Document.SourceCase getSourceCase()
Returns
Type Description
Document.SourceCase

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

Returns
Type Description
Document.State

The state.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

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

Returns
Type Description
boolean

Whether the content field is set.

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;

Returns
Type Description
boolean

Whether the contentUri field is set.

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

Returns
Type Description
boolean

Whether the latestReloadStatus field is set.

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;

Returns
Type Description
boolean

Whether the rawContent field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Document other)

public Document.Builder mergeFrom(Document other)
Parameter
Name Description
other Document
Returns
Type Description
Document.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Builder
Overrides

mergeLatestReloadStatus(Document.ReloadStatus value)

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

Parameter
Name Description
value Document.ReloadStatus
Returns
Type Description
Document.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Builder
Overrides

putAllMetadata(Map<String,String> values)

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Document.Builder

putMetadata(String key, String value)

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

Parameters
Name Description
key String
value String
Returns
Type Description
Document.Builder

removeMetadata(String key)

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

Parameter
Name Description
key String
Returns
Type Description
Document.Builder

setContent(String value) (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];

Parameter
Name Description
value String

The content to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setContentBytes(ByteString value) (deprecated)

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

Parameter
Name Description
value ByteString

The bytes for content to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setContentUri(String value)

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;

Parameter
Name Description
value String

The contentUri to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setContentUriBytes(ByteString value)

public Document.Builder setContentUriBytes(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;

Parameter
Name Description
value ByteString

The bytes for contentUri to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setDisplayName(String value)

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setEnableAutoReload(boolean value)

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

Parameter
Name Description
value boolean

The enableAutoReload to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Builder
Overrides

setKnowledgeTypes(int index, Document.KnowledgeType value)

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
Name Description
index int

The index to set the value at.
value Document.KnowledgeType

The knowledgeTypes to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setKnowledgeTypesValue(int index, int value)

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
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for knowledgeTypes to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setLatestReloadStatus(Document.ReloadStatus value)

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

Parameter
Name Description
value Document.ReloadStatus
Returns
Type Description
Document.Builder

setLatestReloadStatus(Document.ReloadStatus.Builder builderForValue)

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

Parameter
Name Description
builderForValue Document.ReloadStatus.Builder
Returns
Type Description
Document.Builder

setMimeType(String value)

public Document.Builder setMimeType(String value)

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The mimeType to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public Document.Builder setMimeTypeBytes(ByteString value)

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for mimeType to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setRawContent(ByteString value)

public Document.Builder setRawContent(ByteString value)

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

bytes raw_content = 9;

Parameter
Name Description
value ByteString

The rawContent to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Builder
Overrides

setState(Document.State value)

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

Parameter
Name Description
value Document.State

The state to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setStateValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Builder
Overrides