- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface DocumentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAsyncEnabled() (deprecated)
public abstract boolean getAsyncEnabled()Deprecated. google.cloud.contentwarehouse.v1.Document.async_enabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=108
If true, makes the document visible to asynchronous policies and rules.
bool async_enabled = 12 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
The asyncEnabled. |
getCloudAiDocument()
public abstract Document getCloudAiDocument()Document AI format to save the structured content, including OCR.
.google.cloud.documentai.v1.Document cloud_ai_document = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.documentai.v1.Document |
The cloudAiDocument. |
getCloudAiDocumentOrBuilder()
public abstract DocumentOrBuilder getCloudAiDocumentOrBuilder()Document AI format to save the structured content, including OCR.
.google.cloud.documentai.v1.Document cloud_ai_document = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.documentai.v1.DocumentOrBuilder |
|
getContentCategory()
public abstract ContentCategory getContentCategory()Indicates the category (image, audio, video etc.) of the original content.
.google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
| Returns | |
|---|---|
| Type | Description |
ContentCategory |
The contentCategory. |
getContentCategoryValue()
public abstract int getContentCategoryValue()Indicates the category (image, audio, video etc.) of the original content.
.google.cloud.contentwarehouse.v1.ContentCategory content_category = 20;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for contentCategory. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. The time when the document is created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time when the document is created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreator()
public abstract String getCreator()The user who creates the document.
string creator = 13;
| Returns | |
|---|---|
| Type | Description |
String |
The creator. |
getCreatorBytes()
public abstract ByteString getCreatorBytes()The user who creates the document.
string creator = 13;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creator. |
getDisplayName()
public abstract String getDisplayName()Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDisplayUri()
public abstract String getDisplayUri()Uri to display the document, for example, in the UI.
string display_uri = 17;
| Returns | |
|---|---|
| Type | Description |
String |
The displayUri. |
getDisplayUriBytes()
public abstract ByteString getDisplayUriBytes()Uri to display the document, for example, in the UI.
string display_uri = 17;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayUri. |
getDispositionTime()
public abstract Timestamp getDispositionTime()Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
.google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The dispositionTime. |
getDispositionTimeOrBuilder()
public abstract TimestampOrBuilder getDispositionTimeOrBuilder()Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
.google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDocumentSchemaName()
public abstract String getDocumentSchemaName()The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The documentSchemaName. |
getDocumentSchemaNameBytes()
public abstract ByteString getDocumentSchemaNameBytes()The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string document_schema_name = 3 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for documentSchemaName. |
getInlineRawDocument()
public abstract ByteString getInlineRawDocument()Raw document content.
bytes inline_raw_document = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The inlineRawDocument. |
getLegalHold()
public abstract boolean getLegalHold()Output only. Indicates if the document has a legal hold on it.
bool legal_hold = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The legalHold. |
getName()
public abstract String getName()The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
The name is ignored when creating a document.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
The name is ignored when creating a document.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPlainText()
public abstract String getPlainText()Other document format, such as PPTX, XLXS
string plain_text = 15;
| Returns | |
|---|---|
| Type | Description |
String |
The plainText. |
getPlainTextBytes()
public abstract ByteString getPlainTextBytes()Other document format, such as PPTX, XLXS
string plain_text = 15;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for plainText. |
getProperties(int index)
public abstract Property getProperties(int index)List of values that are user supplied metadata.
repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Property |
|
getPropertiesCount()
public abstract int getPropertiesCount()List of values that are user supplied metadata.
repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getPropertiesList()
public abstract List<Property> getPropertiesList()List of values that are user supplied metadata.
repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
| Returns | |
|---|---|
| Type | Description |
List<Property> |
|
getPropertiesOrBuilder(int index)
public abstract PropertyOrBuilder getPropertiesOrBuilder(int index)List of values that are user supplied metadata.
repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PropertyOrBuilder |
|
getPropertiesOrBuilderList()
public abstract List<? extends PropertyOrBuilder> getPropertiesOrBuilderList()List of values that are user supplied metadata.
repeated .google.cloud.contentwarehouse.v1.Property properties = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.contentwarehouse.v1.PropertyOrBuilder> |
|
getRawDocumentCase()
public abstract Document.RawDocumentCase getRawDocumentCase()| Returns | |
|---|---|
| Type | Description |
Document.RawDocumentCase |
|
getRawDocumentFileType()
public abstract RawDocumentFileType getRawDocumentFileType()This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
| Returns | |
|---|---|
| Type | Description |
RawDocumentFileType |
The rawDocumentFileType. |
getRawDocumentFileTypeValue()
public abstract int getRawDocumentFileTypeValue()This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for rawDocumentFileType. |
getRawDocumentPath()
public abstract String getRawDocumentPath()Raw document file in Cloud Storage path.
string raw_document_path = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The rawDocumentPath. |
getRawDocumentPathBytes()
public abstract ByteString getRawDocumentPathBytes()Raw document file in Cloud Storage path.
string raw_document_path = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rawDocumentPath. |
getReferenceId()
public abstract String getReferenceId()The reference ID set by customers. Must be unique per project and location.
string reference_id = 11;
| Returns | |
|---|---|
| Type | Description |
String |
The referenceId. |
getReferenceIdBytes()
public abstract ByteString getReferenceIdBytes()The reference ID set by customers. Must be unique per project and location.
string reference_id = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for referenceId. |
getStructuredContentCase()
public abstract Document.StructuredContentCase getStructuredContentCase()| Returns | |
|---|---|
| Type | Description |
Document.StructuredContentCase |
|
getStructuredContentUri() (deprecated)
public abstract String getStructuredContentUri()Deprecated. google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
A path linked to structured content file.
string structured_content_uri = 16 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
String |
The structuredContentUri. |
getStructuredContentUriBytes() (deprecated)
public abstract ByteString getStructuredContentUriBytes()Deprecated. google.cloud.contentwarehouse.v1.Document.structured_content_uri is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=79
A path linked to structured content file.
string structured_content_uri = 16 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for structuredContentUri. |
getTextExtractionDisabled() (deprecated)
public abstract boolean getTextExtractionDisabled()Deprecated. google.cloud.contentwarehouse.v1.Document.text_extraction_disabled is deprecated. See google/cloud/contentwarehouse/v1/document.proto;l=114
If true, text extraction will not be performed.
bool text_extraction_disabled = 19 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
The textExtractionDisabled. |
getTextExtractionEnabled()
public abstract boolean getTextExtractionEnabled()If true, text extraction will be performed.
bool text_extraction_enabled = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
The textExtractionEnabled. |
getTitle()
public abstract String getTitle()Title that describes the document. This can be the top heading or text that describes the document.
string title = 18;
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public abstract ByteString getTitleBytes()Title that describes the document. This can be the top heading or text that describes the document.
string title = 18;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. The time when the document is last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time when the document is last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getUpdater()
public abstract String getUpdater()The user who lastly updates the document.
string updater = 14;
| Returns | |
|---|---|
| Type | Description |
String |
The updater. |
getUpdaterBytes()
public abstract ByteString getUpdaterBytes()The user who lastly updates the document.
string updater = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for updater. |
hasCloudAiDocument()
public abstract boolean hasCloudAiDocument()Document AI format to save the structured content, including OCR.
.google.cloud.documentai.v1.Document cloud_ai_document = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cloudAiDocument field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. The time when the document is created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDispositionTime()
public abstract boolean hasDispositionTime()Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
.google.protobuf.Timestamp disposition_time = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dispositionTime field is set. |
hasInlineRawDocument()
public abstract boolean hasInlineRawDocument()Raw document content.
bytes inline_raw_document = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inlineRawDocument field is set. |
hasPlainText()
public abstract boolean hasPlainText()Other document format, such as PPTX, XLXS
string plain_text = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the plainText field is set. |
hasRawDocumentPath()
public abstract boolean hasRawDocumentPath()Raw document file in Cloud Storage path.
string raw_document_path = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rawDocumentPath field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. The time when the document is last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |