Interface DocumentOrBuilder (4.15.0)

Version 4.15.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface DocumentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract 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

getContentUri()

public abstract 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 abstract 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.

getDisplayName()

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

Returns

Type	Description
boolean	The enableAutoReload.

getKnowledgeTypes(int index)

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

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 abstract int getKnowledgeTypesCount()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
int	The count of knowledgeTypes.

getKnowledgeTypesList()

public abstract List<Document.KnowledgeType> getKnowledgeTypesList()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
List<KnowledgeType>	A list containing the knowledgeTypes.

getKnowledgeTypesValue(int index)

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

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 abstract List<Integer> getKnowledgeTypesValueList()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
List<Integer>	A list containing the enum numeric values on the wire for knowledgeTypes.

getLatestReloadStatus()

public abstract Document.ReloadStatus getLatestReloadStatus()

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

.google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Document.ReloadStatus	The latestReloadStatus.

getLatestReloadStatusOrBuilder()

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

Returns

Type	Description
Document.ReloadStatusOrBuilder

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns

Type	Description
Map<String,String>

getMetadataCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getName()

public abstract 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 abstract 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 abstract 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 abstract Document.SourceCase getSourceCase()

Returns

Type	Description
Document.SourceCase

getState()

public abstract Document.State getState()

Output only. The current state of the document.

.google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Document.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the document.

.google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The enum numeric value on the wire for state.

hasContentUri()

public abstract 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 abstract boolean hasLatestReloadStatus()

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

.google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the latestReloadStatus field is set.

hasRawContent()

public abstract 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.