- 2.66.0 (latest)
- 2.64.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public interface DocumentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBlobAssets(int index)
public abstract Document.BlobAsset getBlobAssets(int index)Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1beta3.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.BlobAsset |
|
getBlobAssetsCount()
public abstract int getBlobAssetsCount()Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1beta3.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getBlobAssetsList()
public abstract List<Document.BlobAsset> getBlobAssetsList()Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1beta3.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<BlobAsset> |
|
getBlobAssetsOrBuilder(int index)
public abstract Document.BlobAssetOrBuilder getBlobAssetsOrBuilder(int index)Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1beta3.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.BlobAssetOrBuilder |
|
getBlobAssetsOrBuilderList()
public abstract List<? extends Document.BlobAssetOrBuilder> getBlobAssetsOrBuilderList()Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1beta3.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.BlobAssetOrBuilder> |
|
getChunkedDocument()
public abstract Document.ChunkedDocument getChunkedDocument()Document chunked based on chunking config.
.google.cloud.documentai.v1beta3.Document.ChunkedDocument chunked_document = 18;
| Returns | |
|---|---|
| Type | Description |
Document.ChunkedDocument |
The chunkedDocument. |
getChunkedDocumentOrBuilder()
public abstract Document.ChunkedDocumentOrBuilder getChunkedDocumentOrBuilder()Document chunked based on chunking config.
.google.cloud.documentai.v1beta3.Document.ChunkedDocument chunked_document = 18;
| Returns | |
|---|---|
| Type | Description |
Document.ChunkedDocumentOrBuilder |
|
getContent()
public abstract ByteString getContent() Optional. Inline document content, represented as a stream of bytes.
Note: As with all bytes fields, protobuffers use a pure binary
representation, whereas JSON representations use base64.
bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The content. |
getDocid()
public abstract String getDocid()Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The docid. |
getDocidBytes()
public abstract ByteString getDocidBytes()Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for docid. |
getDocumentLayout()
public abstract Document.DocumentLayout getDocumentLayout()Parsed layout of the document.
.google.cloud.documentai.v1beta3.Document.DocumentLayout document_layout = 17;
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
The documentLayout. |
getDocumentLayoutOrBuilder()
public abstract Document.DocumentLayoutOrBuilder getDocumentLayoutOrBuilder()Parsed layout of the document.
.google.cloud.documentai.v1beta3.Document.DocumentLayout document_layout = 17;
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayoutOrBuilder |
|
getEntities(int index)
public abstract Document.Entity getEntities(int index)A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.Entity |
|
getEntitiesCount()
public abstract int getEntitiesCount()A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEntitiesList()
public abstract List<Document.Entity> getEntitiesList()A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
| Returns | |
|---|---|
| Type | Description |
List<Entity> |
|
getEntitiesOrBuilder(int index)
public abstract Document.EntityOrBuilder getEntitiesOrBuilder(int index)A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.EntityOrBuilder |
|
getEntitiesOrBuilderList()
public abstract List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta3.Document.Entity entities = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.EntityOrBuilder> |
|
getEntityRelations(int index)
public abstract Document.EntityRelation getEntityRelations(int index)Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.EntityRelation |
|
getEntityRelationsCount()
public abstract int getEntityRelationsCount()Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEntityRelationsList()
public abstract List<Document.EntityRelation> getEntityRelationsList()Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
| Returns | |
|---|---|
| Type | Description |
List<EntityRelation> |
|
getEntityRelationsOrBuilder(int index)
public abstract Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.EntityRelationOrBuilder |
|
getEntityRelationsOrBuilderList()
public abstract List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1beta3.Document.EntityRelation entity_relations = 8;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.EntityRelationOrBuilder> |
|
getError()
public abstract Status getError()Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public abstract StatusOrBuilder getErrorOrBuilder()Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getMimeType()
public abstract String getMimeType()An IANA published media type (MIME type).
string mime_type = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The mimeType. |
getMimeTypeBytes()
public abstract ByteString getMimeTypeBytes()An IANA published media type (MIME type).
string mime_type = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mimeType. |
getPages(int index)
public abstract Document.Page getPages(int index)Visual page layout for the Document.
repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.Page |
|
getPagesCount()
public abstract int getPagesCount()Visual page layout for the Document.
repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
| Returns | |
|---|---|
| Type | Description |
int |
|
getPagesList()
public abstract List<Document.Page> getPagesList()Visual page layout for the Document.
repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
| Returns | |
|---|---|
| Type | Description |
List<Page> |
|
getPagesOrBuilder(int index)
public abstract Document.PageOrBuilder getPagesOrBuilder(int index)Visual page layout for the Document.
repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.PageOrBuilder |
|
getPagesOrBuilderList()
public abstract List<? extends Document.PageOrBuilder> getPagesOrBuilderList()Visual page layout for the Document.
repeated .google.cloud.documentai.v1beta3.Document.Page pages = 6;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.PageOrBuilder> |
|
getRevisions(int index)
public abstract Document.Revision getRevisions(int index)Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.Revision |
|
getRevisionsCount()
public abstract int getRevisionsCount()Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRevisionsList()
public abstract List<Document.Revision> getRevisionsList()Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
| Returns | |
|---|---|
| Type | Description |
List<Revision> |
|
getRevisionsOrBuilder(int index)
public abstract Document.RevisionOrBuilder getRevisionsOrBuilder(int index)Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.RevisionOrBuilder |
|
getRevisionsOrBuilderList()
public abstract List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1beta3.Document.Revision revisions = 13;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.RevisionOrBuilder> |
|
getShardInfo()
public abstract Document.ShardInfo getShardInfo()Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
.google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
| Returns | |
|---|---|
| Type | Description |
Document.ShardInfo |
The shardInfo. |
getShardInfoOrBuilder()
public abstract Document.ShardInfoOrBuilder getShardInfoOrBuilder()Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
.google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
| Returns | |
|---|---|
| Type | Description |
Document.ShardInfoOrBuilder |
|
getSourceCase()
public abstract Document.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
Document.SourceCase |
|
getText()
public abstract String getText()Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The text. |
getTextBytes()
public abstract ByteString getTextBytes()Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for text. |
getTextChanges(int index)
public abstract Document.TextChange getTextChanges(int index)Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.TextChange |
|
getTextChangesCount()
public abstract int getTextChangesCount()Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
| Returns | |
|---|---|
| Type | Description |
int |
|
getTextChangesList()
public abstract List<Document.TextChange> getTextChangesList()Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
| Returns | |
|---|---|
| Type | Description |
List<TextChange> |
|
getTextChangesOrBuilder(int index)
public abstract Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.TextChangeOrBuilder |
|
getTextChangesOrBuilderList()
public abstract List<? extends Document.TextChangeOrBuilder> getTextChangesOrBuilderList()Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
repeated .google.cloud.documentai.v1beta3.Document.TextChange text_changes = 14;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.TextChangeOrBuilder> |
|
getTextStyles(int index) (deprecated)
public abstract Document.Style getTextStyles(int index)Styles for the Document.text.
repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.Style |
|
getTextStylesCount() (deprecated)
public abstract int getTextStylesCount()Styles for the Document.text.
repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int |
|
getTextStylesList() (deprecated)
public abstract List<Document.Style> getTextStylesList()Styles for the Document.text.
repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<Style> |
|
getTextStylesOrBuilder(int index) (deprecated)
public abstract Document.StyleOrBuilder getTextStylesOrBuilder(int index)Styles for the Document.text.
repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.StyleOrBuilder |
|
getTextStylesOrBuilderList() (deprecated)
public abstract List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()Styles for the Document.text.
repeated .google.cloud.documentai.v1beta3.Document.Style text_styles = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.StyleOrBuilder> |
|
getUri()
public abstract String getUri() Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
For more information, refer to Google Cloud Storage Request
URIs.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The uri. |
getUriBytes()
public abstract ByteString getUriBytes() Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
For more information, refer to Google Cloud Storage Request
URIs.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uri. |
hasChunkedDocument()
public abstract boolean hasChunkedDocument()Document chunked based on chunking config.
.google.cloud.documentai.v1beta3.Document.ChunkedDocument chunked_document = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the chunkedDocument field is set. |
hasContent()
public abstract boolean hasContent() Optional. Inline document content, represented as a stream of bytes.
Note: As with all bytes fields, protobuffers use a pure binary
representation, whereas JSON representations use base64.
bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the content field is set. |
hasDocumentLayout()
public abstract boolean hasDocumentLayout()Parsed layout of the document.
.google.cloud.documentai.v1beta3.Document.DocumentLayout document_layout = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the documentLayout field is set. |
hasError()
public abstract boolean hasError()Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the error field is set. |
hasShardInfo()
public abstract boolean hasShardInfo()Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
.google.cloud.documentai.v1beta3.Document.ShardInfo shard_info = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shardInfo field is set. |
hasUri()
public abstract boolean hasUri() Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
For more information, refer to Google Cloud Storage Request
URIs.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the uri field is set. |