Package com.google.cloud.documentai.v1
Class Document.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
com.google.cloud.documentai.v1.Document.Builder
- All Implemented Interfaces:
DocumentOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- Document
public static final class Document.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
implements DocumentOrBuilder
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.Protobuf type
google.cloud.documentai.v1.Document-
Method Summary
Modifier and TypeMethodDescriptionaddAllBlobAssets(Iterable<? extends Document.BlobAsset> values) Optional.addAllEntities(Iterable<? extends Document.Entity> values) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addAllEntitiesRevisions(Iterable<? extends Document.EntitiesRevision> values) A list of entity revisions.addAllEntityRelations(Iterable<? extends Document.EntityRelation> values) Placeholder.addAllPages(Iterable<? extends Document.Page> values) Visual page layout for the [Document][google.cloud.documentai.v1.Document].addAllRevisions(Iterable<? extends Document.Revision> values) Placeholder.addAllTextChanges(Iterable<? extends Document.TextChange> values) Placeholder.addAllTextStyles(Iterable<? extends Document.Style> values) Deprecated.addBlobAssets(int index, Document.BlobAsset value) Optional.addBlobAssets(int index, Document.BlobAsset.Builder builderForValue) Optional.addBlobAssets(Document.BlobAsset value) Optional.addBlobAssets(Document.BlobAsset.Builder builderForValue) Optional.Optional.addBlobAssetsBuilder(int index) Optional.addEntities(int index, Document.Entity value) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addEntities(int index, Document.Entity.Builder builderForValue) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addEntities(Document.Entity value) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addEntities(Document.Entity.Builder builderForValue) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addEntitiesBuilder(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].addEntitiesRevisions(int index, Document.EntitiesRevision value) A list of entity revisions.addEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue) A list of entity revisions.A list of entity revisions.addEntitiesRevisions(Document.EntitiesRevision.Builder builderForValue) A list of entity revisions.A list of entity revisions.addEntitiesRevisionsBuilder(int index) A list of entity revisions.addEntityRelations(int index, Document.EntityRelation value) Placeholder.addEntityRelations(int index, Document.EntityRelation.Builder builderForValue) Placeholder.Placeholder.addEntityRelations(Document.EntityRelation.Builder builderForValue) Placeholder.Placeholder.addEntityRelationsBuilder(int index) Placeholder.addPages(int index, Document.Page value) Visual page layout for the [Document][google.cloud.documentai.v1.Document].addPages(int index, Document.Page.Builder builderForValue) Visual page layout for the [Document][google.cloud.documentai.v1.Document].addPages(Document.Page value) Visual page layout for the [Document][google.cloud.documentai.v1.Document].addPages(Document.Page.Builder builderForValue) Visual page layout for the [Document][google.cloud.documentai.v1.Document].Visual page layout for the [Document][google.cloud.documentai.v1.Document].addPagesBuilder(int index) Visual page layout for the [Document][google.cloud.documentai.v1.Document].addRevisions(int index, Document.Revision value) Placeholder.addRevisions(int index, Document.Revision.Builder builderForValue) Placeholder.addRevisions(Document.Revision value) Placeholder.addRevisions(Document.Revision.Builder builderForValue) Placeholder.Placeholder.addRevisionsBuilder(int index) Placeholder.addTextChanges(int index, Document.TextChange value) Placeholder.addTextChanges(int index, Document.TextChange.Builder builderForValue) Placeholder.Placeholder.addTextChanges(Document.TextChange.Builder builderForValue) Placeholder.Placeholder.addTextChangesBuilder(int index) Placeholder.addTextStyles(int index, Document.Style value) Deprecated.addTextStyles(int index, Document.Style.Builder builderForValue) Deprecated.addTextStyles(Document.Style value) Deprecated.addTextStyles(Document.Style.Builder builderForValue) Deprecated.Deprecated.addTextStylesBuilder(int index) Deprecated.build()clear()Optional.Document chunked based on chunking config.Optional.Optional.Parsed layout of the document.A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].The entity revision ID that `document.entities` field is based on.A list of entity revisions.Placeholder.The entity validation output for the document.Any error that occurred while processing this document.An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).Visual page layout for the [Document][google.cloud.documentai.v1.Document].Placeholder.Information about the sharding if this document is sharded part of a larger document.Optional.Placeholder.Deprecated.clearUri()Optional.getBlobAssets(int index) Optional.getBlobAssetsBuilder(int index) Optional.Optional.intOptional.Optional.getBlobAssetsOrBuilder(int index) Optional.List<? extends Document.BlobAssetOrBuilder>Optional.Document chunked based on chunking config.Document chunked based on chunking config.Document chunked based on chunking config.com.google.protobuf.ByteStringOptional.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetDocid()Optional.com.google.protobuf.ByteStringOptional.Parsed layout of the document.Parsed layout of the document.Parsed layout of the document.getEntities(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].getEntitiesBuilder(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].intA list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].getEntitiesOrBuilder(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].List<? extends Document.EntityOrBuilder>A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].The entity revision ID that `document.entities` field is based on.com.google.protobuf.ByteStringThe entity revision ID that `document.entities` field is based on.getEntitiesRevisions(int index) A list of entity revisions.getEntitiesRevisionsBuilder(int index) A list of entity revisions.A list of entity revisions.intA list of entity revisions.A list of entity revisions.getEntitiesRevisionsOrBuilder(int index) A list of entity revisions.List<? extends Document.EntitiesRevisionOrBuilder>A list of entity revisions.getEntityRelations(int index) Placeholder.getEntityRelationsBuilder(int index) Placeholder.Placeholder.intPlaceholder.Placeholder.getEntityRelationsOrBuilder(int index) Placeholder.List<? extends Document.EntityRelationOrBuilder>Placeholder.The entity validation output for the document.The entity validation output for the document.The entity validation output for the document.getError()Any error that occurred while processing this document.Any error that occurred while processing this document.Any error that occurred while processing this document.An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).com.google.protobuf.ByteStringAn IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).getPages(int index) Visual page layout for the [Document][google.cloud.documentai.v1.Document].getPagesBuilder(int index) Visual page layout for the [Document][google.cloud.documentai.v1.Document].Visual page layout for the [Document][google.cloud.documentai.v1.Document].intVisual page layout for the [Document][google.cloud.documentai.v1.Document].Visual page layout for the [Document][google.cloud.documentai.v1.Document].getPagesOrBuilder(int index) Visual page layout for the [Document][google.cloud.documentai.v1.Document].List<? extends Document.PageOrBuilder>Visual page layout for the [Document][google.cloud.documentai.v1.Document].getRevisions(int index) Placeholder.getRevisionsBuilder(int index) Placeholder.Placeholder.intPlaceholder.Placeholder.getRevisionsOrBuilder(int index) Placeholder.List<? extends Document.RevisionOrBuilder>Placeholder.Information about the sharding if this document is sharded part of a larger document.Information about the sharding if this document is sharded part of a larger document.Information about the sharding if this document is sharded part of a larger document.getText()Optional.com.google.protobuf.ByteStringOptional.getTextChanges(int index) Placeholder.getTextChangesBuilder(int index) Placeholder.Placeholder.intPlaceholder.Placeholder.getTextChangesOrBuilder(int index) Placeholder.List<? extends Document.TextChangeOrBuilder>Placeholder.getTextStyles(int index) Deprecated.getTextStylesBuilder(int index) Deprecated.Deprecated.intDeprecated.Deprecated.getTextStylesOrBuilder(int index) Deprecated.List<? extends Document.StyleOrBuilder>Deprecated.getUri()Optional.com.google.protobuf.ByteStringOptional.booleanDocument chunked based on chunking config.booleanOptional.booleanParsed layout of the document.booleanThe entity validation output for the document.booleanhasError()Any error that occurred while processing this document.booleanInformation about the sharding if this document is sharded part of a larger document.booleanhasUri()Optional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanDocument chunked based on chunking config.Parsed layout of the document.The entity validation output for the document.mergeError(Status value) Any error that occurred while processing this document.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeShardInfo(Document.ShardInfo value) Information about the sharding if this document is sharded part of a larger document.removeBlobAssets(int index) Optional.removeEntities(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].removeEntitiesRevisions(int index) A list of entity revisions.removeEntityRelations(int index) Placeholder.removePages(int index) Visual page layout for the [Document][google.cloud.documentai.v1.Document].removeRevisions(int index) Placeholder.removeTextChanges(int index) Placeholder.removeTextStyles(int index) Deprecated.setBlobAssets(int index, Document.BlobAsset value) Optional.setBlobAssets(int index, Document.BlobAsset.Builder builderForValue) Optional.Document chunked based on chunking config.setChunkedDocument(Document.ChunkedDocument.Builder builderForValue) Document chunked based on chunking config.setContent(com.google.protobuf.ByteString value) Optional.Optional.setDocidBytes(com.google.protobuf.ByteString value) Optional.Parsed layout of the document.setDocumentLayout(Document.DocumentLayout.Builder builderForValue) Parsed layout of the document.setEntities(int index, Document.Entity value) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].setEntities(int index, Document.Entity.Builder builderForValue) A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text].setEntitiesRevisionId(String value) The entity revision ID that `document.entities` field is based on.setEntitiesRevisionIdBytes(com.google.protobuf.ByteString value) The entity revision ID that `document.entities` field is based on.setEntitiesRevisions(int index, Document.EntitiesRevision value) A list of entity revisions.setEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue) A list of entity revisions.setEntityRelations(int index, Document.EntityRelation value) Placeholder.setEntityRelations(int index, Document.EntityRelation.Builder builderForValue) Placeholder.The entity validation output for the document.setEntityValidationOutput(Document.EntityValidationOutput.Builder builderForValue) The entity validation output for the document.Any error that occurred while processing this document.setError(Status.Builder builderForValue) Any error that occurred while processing this document.setMimeType(String value) An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).setMimeTypeBytes(com.google.protobuf.ByteString value) An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).setPages(int index, Document.Page value) Visual page layout for the [Document][google.cloud.documentai.v1.Document].setPages(int index, Document.Page.Builder builderForValue) Visual page layout for the [Document][google.cloud.documentai.v1.Document].setRevisions(int index, Document.Revision value) Placeholder.setRevisions(int index, Document.Revision.Builder builderForValue) Placeholder.setShardInfo(Document.ShardInfo value) Information about the sharding if this document is sharded part of a larger document.setShardInfo(Document.ShardInfo.Builder builderForValue) Information about the sharding if this document is sharded part of a larger document.Optional.setTextBytes(com.google.protobuf.ByteString value) Optional.setTextChanges(int index, Document.TextChange value) Placeholder.setTextChanges(int index, Document.TextChange.Builder builderForValue) Placeholder.setTextStyles(int index, Document.Style value) Deprecated.setTextStyles(int index, Document.Style.Builder builderForValue) Deprecated.Optional.setUriBytes(com.google.protobuf.ByteString value) Optional.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<Document.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<Document.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<Document.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Document.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<Document.Builder>
-
mergeFrom
public Document.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Document.Builder>- Throws:
IOException
-
getSourceCase
- Specified by:
getSourceCasein interfaceDocumentOrBuilder
-
clearSource
-
hasUri
public 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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasUriin interfaceDocumentOrBuilder- Returns:
- Whether the uri field is set.
-
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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUriin interfaceDocumentOrBuilder- Returns:
- The uri.
-
getUriBytes
public com.google.protobuf.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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUriBytesin interfaceDocumentOrBuilder- Returns:
- The bytes for uri.
-
setUri
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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The uri to set.- Returns:
- This builder for chaining.
-
clearUri
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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
setUriBytes
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](https://cloud.google.com/storage/docs/reference-uris).
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The bytes for uri to set.- Returns:
- This builder for chaining.
-
hasContent
public 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];- Specified by:
hasContentin interfaceDocumentOrBuilder- Returns:
- Whether the content field is set.
-
getContent
public com.google.protobuf.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];- Specified by:
getContentin interfaceDocumentOrBuilder- Returns:
- The content.
-
setContent
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];- Parameters:
value- The content to set.- Returns:
- This builder for chaining.
-
clearContent
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:
- This builder for chaining.
-
getDocid
Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDocidin interfaceDocumentOrBuilder- Returns:
- The docid.
-
getDocidBytes
public com.google.protobuf.ByteString getDocidBytes()Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDocidBytesin interfaceDocumentOrBuilder- Returns:
- The bytes for docid.
-
setDocid
Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The docid to set.- Returns:
- This builder for chaining.
-
clearDocid
Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
setDocidBytes
Optional. An internal identifier for document. Should be loggable (no PII).
string docid = 15 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The bytes for docid to set.- Returns:
- This builder for chaining.
-
getMimeType
An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
string mime_type = 3;- Specified by:
getMimeTypein interfaceDocumentOrBuilder- Returns:
- The mimeType.
-
getMimeTypeBytes
public com.google.protobuf.ByteString getMimeTypeBytes()An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
string mime_type = 3;- Specified by:
getMimeTypeBytesin interfaceDocumentOrBuilder- Returns:
- The bytes for mimeType.
-
setMimeType
An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
string mime_type = 3;- Parameters:
value- The mimeType to set.- Returns:
- This builder for chaining.
-
clearMimeType
An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
string mime_type = 3;- Returns:
- This builder for chaining.
-
setMimeTypeBytes
An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
string mime_type = 3;- Parameters:
value- The bytes for mimeType to set.- Returns:
- This builder for chaining.
-
getText
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getTextin interfaceDocumentOrBuilder- Returns:
- The text.
-
getTextBytes
public com.google.protobuf.ByteString getTextBytes()Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getTextBytesin interfaceDocumentOrBuilder- Returns:
- The bytes for text.
-
setText
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The text to set.- Returns:
- This builder for chaining.
-
clearText
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-
setTextBytes
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The bytes for text to set.- Returns:
- This builder for chaining.
-
getTextStylesList
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];- Specified by:
getTextStylesListin interfaceDocumentOrBuilder
-
getTextStylesCount
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];- Specified by:
getTextStylesCountin interfaceDocumentOrBuilder
-
getTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];- Specified by:
getTextStylesin interfaceDocumentOrBuilder
-
setTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
setTextStyles
@Deprecated public Document.Builder setTextStyles(int index, Document.Style.Builder builderForValue) Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addTextStyles
@Deprecated public Document.Builder addTextStyles(int index, Document.Style.Builder builderForValue) Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addAllTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
clearTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
removeTextStyles
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
getTextStylesBuilder
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
getTextStylesOrBuilder
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];- Specified by:
getTextStylesOrBuilderin interfaceDocumentOrBuilder
-
getTextStylesOrBuilderList
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];- Specified by:
getTextStylesOrBuilderListin interfaceDocumentOrBuilder
-
addTextStylesBuilder
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
addTextStylesBuilder
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
getTextStylesBuilderList
Deprecated.Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; -
getPagesList
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6;- Specified by:
getPagesListin interfaceDocumentOrBuilder
-
getPagesCount
public int getPagesCount()Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6;- Specified by:
getPagesCountin interfaceDocumentOrBuilder
-
getPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6;- Specified by:
getPagesin interfaceDocumentOrBuilder
-
setPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
setPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addAllPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
clearPages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
removePages
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
getPagesBuilder
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
getPagesOrBuilder
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6;- Specified by:
getPagesOrBuilderin interfaceDocumentOrBuilder
-
getPagesOrBuilderList
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6;- Specified by:
getPagesOrBuilderListin interfaceDocumentOrBuilder
-
addPagesBuilder
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
addPagesBuilder
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
getPagesBuilderList
Visual page layout for the [Document][google.cloud.documentai.v1.Document].
repeated .google.cloud.documentai.v1.Document.Page pages = 6; -
getEntitiesList
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;- Specified by:
getEntitiesListin interfaceDocumentOrBuilder
-
getEntitiesCount
public int getEntitiesCount()A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;- Specified by:
getEntitiesCountin interfaceDocumentOrBuilder
-
getEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;- Specified by:
getEntitiesin interfaceDocumentOrBuilder
-
setEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
setEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addAllEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
clearEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
removeEntities
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
getEntitiesBuilder
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
getEntitiesOrBuilder
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;- Specified by:
getEntitiesOrBuilderin interfaceDocumentOrBuilder
-
getEntitiesOrBuilderList
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;- Specified by:
getEntitiesOrBuilderListin interfaceDocumentOrBuilder
-
addEntitiesBuilder
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
addEntitiesBuilder
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
getEntitiesBuilderList
A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7; -
getEntityRelationsList
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;- Specified by:
getEntityRelationsListin interfaceDocumentOrBuilder
-
getEntityRelationsCount
public int getEntityRelationsCount()Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;- Specified by:
getEntityRelationsCountin interfaceDocumentOrBuilder
-
getEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;- Specified by:
getEntityRelationsin interfaceDocumentOrBuilder
-
setEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
setEntityRelations
public Document.Builder setEntityRelations(int index, Document.EntityRelation.Builder builderForValue) Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addEntityRelations
public Document.Builder addEntityRelations(int index, Document.EntityRelation.Builder builderForValue) Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addAllEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
clearEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
removeEntityRelations
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
getEntityRelationsBuilder
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
getEntityRelationsOrBuilder
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;- Specified by:
getEntityRelationsOrBuilderin interfaceDocumentOrBuilder
-
getEntityRelationsOrBuilderList
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;- Specified by:
getEntityRelationsOrBuilderListin interfaceDocumentOrBuilder
-
addEntityRelationsBuilder
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
addEntityRelationsBuilder
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
getEntityRelationsBuilderList
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; -
getTextChangesList
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14;- Specified by:
getTextChangesListin interfaceDocumentOrBuilder
-
getTextChangesCount
public int getTextChangesCount()Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14;- Specified by:
getTextChangesCountin interfaceDocumentOrBuilder
-
getTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14;- Specified by:
getTextChangesin interfaceDocumentOrBuilder
-
setTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
setTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addAllTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
clearTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
removeTextChanges
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
getTextChangesBuilder
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
getTextChangesOrBuilder
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14;- Specified by:
getTextChangesOrBuilderin interfaceDocumentOrBuilder
-
getTextChangesOrBuilderList
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14;- Specified by:
getTextChangesOrBuilderListin interfaceDocumentOrBuilder
-
addTextChangesBuilder
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
addTextChangesBuilder
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
getTextChangesBuilderList
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.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.v1.Document.TextChange text_changes = 14; -
hasShardInfo
public 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.v1.Document.ShardInfo shard_info = 9;- Specified by:
hasShardInfoin interfaceDocumentOrBuilder- Returns:
- Whether the shardInfo field is set.
-
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.v1.Document.ShardInfo shard_info = 9;- Specified by:
getShardInfoin interfaceDocumentOrBuilder- Returns:
- The shardInfo.
-
setShardInfo
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.v1.Document.ShardInfo shard_info = 9; -
setShardInfo
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.v1.Document.ShardInfo shard_info = 9; -
mergeShardInfo
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.v1.Document.ShardInfo shard_info = 9; -
clearShardInfo
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.v1.Document.ShardInfo shard_info = 9; -
getShardInfoBuilder
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.v1.Document.ShardInfo shard_info = 9; -
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.v1.Document.ShardInfo shard_info = 9;- Specified by:
getShardInfoOrBuilderin interfaceDocumentOrBuilder
-
hasError
public boolean hasError()Any error that occurred while processing this document.
.google.rpc.Status error = 10;- Specified by:
hasErrorin interfaceDocumentOrBuilder- Returns:
- Whether the error field is set.
-
getError
Any error that occurred while processing this document.
.google.rpc.Status error = 10;- Specified by:
getErrorin interfaceDocumentOrBuilder- Returns:
- The error.
-
setError
Any error that occurred while processing this document.
.google.rpc.Status error = 10; -
setError
Any error that occurred while processing this document.
.google.rpc.Status error = 10; -
mergeError
Any error that occurred while processing this document.
.google.rpc.Status error = 10; -
clearError
Any error that occurred while processing this document.
.google.rpc.Status error = 10; -
getErrorBuilder
Any error that occurred while processing this document.
.google.rpc.Status error = 10; -
getErrorOrBuilder
Any error that occurred while processing this document.
.google.rpc.Status error = 10;- Specified by:
getErrorOrBuilderin interfaceDocumentOrBuilder
-
getRevisionsList
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;- Specified by:
getRevisionsListin interfaceDocumentOrBuilder
-
getRevisionsCount
public int getRevisionsCount()Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;- Specified by:
getRevisionsCountin interfaceDocumentOrBuilder
-
getRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;- Specified by:
getRevisionsin interfaceDocumentOrBuilder
-
setRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
setRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addAllRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
clearRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
removeRevisions
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
getRevisionsBuilder
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
getRevisionsOrBuilder
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;- Specified by:
getRevisionsOrBuilderin interfaceDocumentOrBuilder
-
getRevisionsOrBuilderList
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;- Specified by:
getRevisionsOrBuilderListin interfaceDocumentOrBuilder
-
addRevisionsBuilder
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
addRevisionsBuilder
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
getRevisionsBuilderList
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; -
hasDocumentLayout
public boolean hasDocumentLayout()Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;- Specified by:
hasDocumentLayoutin interfaceDocumentOrBuilder- Returns:
- Whether the documentLayout field is set.
-
getDocumentLayout
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;- Specified by:
getDocumentLayoutin interfaceDocumentOrBuilder- Returns:
- The documentLayout.
-
setDocumentLayout
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; -
setDocumentLayout
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; -
mergeDocumentLayout
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; -
clearDocumentLayout
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; -
getDocumentLayoutBuilder
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; -
getDocumentLayoutOrBuilder
Parsed layout of the document.
.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;- Specified by:
getDocumentLayoutOrBuilderin interfaceDocumentOrBuilder
-
hasChunkedDocument
public boolean hasChunkedDocument()Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;- Specified by:
hasChunkedDocumentin interfaceDocumentOrBuilder- Returns:
- Whether the chunkedDocument field is set.
-
getChunkedDocument
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;- Specified by:
getChunkedDocumentin interfaceDocumentOrBuilder- Returns:
- The chunkedDocument.
-
setChunkedDocument
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; -
setChunkedDocument
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; -
mergeChunkedDocument
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; -
clearChunkedDocument
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; -
getChunkedDocumentBuilder
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; -
getChunkedDocumentOrBuilder
Document chunked based on chunking config.
.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;- Specified by:
getChunkedDocumentOrBuilderin interfaceDocumentOrBuilder
-
getBlobAssetsList
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBlobAssetsListin interfaceDocumentOrBuilder
-
getBlobAssetsCount
public int getBlobAssetsCount()Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBlobAssetsCountin interfaceDocumentOrBuilder
-
getBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBlobAssetsin interfaceDocumentOrBuilder
-
setBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
setBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addAllBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
clearBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
removeBlobAssets
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
getBlobAssetsBuilder
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
getBlobAssetsOrBuilder
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBlobAssetsOrBuilderin interfaceDocumentOrBuilder
-
getBlobAssetsOrBuilderList
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBlobAssetsOrBuilderListin interfaceDocumentOrBuilder
-
addBlobAssetsBuilder
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
addBlobAssetsBuilder
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
getBlobAssetsBuilderList
Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.
repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL]; -
hasEntityValidationOutput
public boolean hasEntityValidationOutput()The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;- Specified by:
hasEntityValidationOutputin interfaceDocumentOrBuilder- Returns:
- Whether the entityValidationOutput field is set.
-
getEntityValidationOutput
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;- Specified by:
getEntityValidationOutputin interfaceDocumentOrBuilder- Returns:
- The entityValidationOutput.
-
setEntityValidationOutput
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21; -
setEntityValidationOutput
public Document.Builder setEntityValidationOutput(Document.EntityValidationOutput.Builder builderForValue) The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21; -
mergeEntityValidationOutput
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21; -
clearEntityValidationOutput
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21; -
getEntityValidationOutputBuilder
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21; -
getEntityValidationOutputOrBuilder
The entity validation output for the document. This is the validation output for `document.entities` field.
.google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;- Specified by:
getEntityValidationOutputOrBuilderin interfaceDocumentOrBuilder
-
getEntitiesRevisionsList
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;- Specified by:
getEntitiesRevisionsListin interfaceDocumentOrBuilder
-
getEntitiesRevisionsCount
public int getEntitiesRevisionsCount()A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;- Specified by:
getEntitiesRevisionsCountin interfaceDocumentOrBuilder
-
getEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;- Specified by:
getEntitiesRevisionsin interfaceDocumentOrBuilder
-
setEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
setEntitiesRevisions
public Document.Builder setEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue) A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addEntitiesRevisions
public Document.Builder addEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue) A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addAllEntitiesRevisions
public Document.Builder addAllEntitiesRevisions(Iterable<? extends Document.EntitiesRevision> values) A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
clearEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
removeEntitiesRevisions
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
getEntitiesRevisionsBuilder
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
getEntitiesRevisionsOrBuilder
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;- Specified by:
getEntitiesRevisionsOrBuilderin interfaceDocumentOrBuilder
-
getEntitiesRevisionsOrBuilderList
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;- Specified by:
getEntitiesRevisionsOrBuilderListin interfaceDocumentOrBuilder
-
addEntitiesRevisionsBuilder
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
addEntitiesRevisionsBuilder
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
getEntitiesRevisionsBuilderList
A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22; -
getEntitiesRevisionId
The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
string entities_revision_id = 23;- Specified by:
getEntitiesRevisionIdin interfaceDocumentOrBuilder- Returns:
- The entitiesRevisionId.
-
getEntitiesRevisionIdBytes
public com.google.protobuf.ByteString getEntitiesRevisionIdBytes()The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
string entities_revision_id = 23;- Specified by:
getEntitiesRevisionIdBytesin interfaceDocumentOrBuilder- Returns:
- The bytes for entitiesRevisionId.
-
setEntitiesRevisionId
The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
string entities_revision_id = 23;- Parameters:
value- The entitiesRevisionId to set.- Returns:
- This builder for chaining.
-
clearEntitiesRevisionId
The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
string entities_revision_id = 23;- Returns:
- This builder for chaining.
-
setEntitiesRevisionIdBytes
The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
string entities_revision_id = 23;- Parameters:
value- The bytes for entitiesRevisionId to set.- Returns:
- This builder for chaining.
-