public final class Document extends GeneratedMessageV3 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.v2.Document
Static Fields
CONTENT_URI_FIELD_NUMBER
public static final int CONTENT_URI_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENABLE_AUTO_RELOAD_FIELD_NUMBER
public static final int ENABLE_AUTO_RELOAD_FIELD_NUMBER
Field Value
KNOWLEDGE_TYPES_FIELD_NUMBER
public static final int KNOWLEDGE_TYPES_FIELD_NUMBER
Field Value
LATEST_RELOAD_STATUS_FIELD_NUMBER
public static final int LATEST_RELOAD_STATUS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RAW_CONTENT_FIELD_NUMBER
public static final int RAW_CONTENT_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Document.Builder newBuilder()
Returns
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
Parameter
Returns
public static Document parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Document> parser()
Returns
Methods
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| 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;
| Type | Description |
| ByteString | The bytes for contentUri.
|
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Returns
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];
| 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];
| 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. PERMISION_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];
| 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.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
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];
| Type | Description |
| int | The count of knowledgeTypes.
|
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];
getKnowledgeTypesValue(int index)
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];
| 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.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
| 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.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];
public Map<String,String> getMetadata()
Returns
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];
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];
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];
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];
getMimeType()
public String getMimeType()
Required. The MIME type of this document.
string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
| 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];
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];
| 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];
getParserForType()
public Parser<Document> getParserForType()
Returns
Overrides
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceCase()
public Document.SourceCase getSourceCase()
Returns
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| 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.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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;
| Type | Description |
| boolean | Whether the rawContent field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Document.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Document.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
