public static final class Document.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder
Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.Protobuf type
google.cloud.documentai.v1beta1.Document| Modifier and Type | Method and Description |
|---|---|
Document.Builder |
addAllEntities(Iterable<? extends Document.Entity> values)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addAllEntityRelations(Iterable<? extends Document.EntityRelation> values)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
addAllPages(Iterable<? extends Document.Page> values)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
addAllTextStyles(Iterable<? extends Document.Style> values)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addEntities(Document.Entity.Builder builderForValue)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addEntities(Document.Entity value)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addEntities(int index,
Document.Entity.Builder builderForValue)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addEntities(int index,
Document.Entity value)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Entity.Builder |
addEntitiesBuilder()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Entity.Builder |
addEntitiesBuilder(int index)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addEntityRelations(Document.EntityRelation.Builder builderForValue)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
addEntityRelations(Document.EntityRelation value)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
addEntityRelations(int index,
Document.EntityRelation.Builder builderForValue)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
addEntityRelations(int index,
Document.EntityRelation value)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.EntityRelation.Builder |
addEntityRelationsBuilder()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.EntityRelation.Builder |
addEntityRelationsBuilder(int index)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
addPages(Document.Page.Builder builderForValue)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
addPages(Document.Page value)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
addPages(int index,
Document.Page.Builder builderForValue)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
addPages(int index,
Document.Page value)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Page.Builder |
addPagesBuilder()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Page.Builder |
addPagesBuilder(int index)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Document.Builder |
addTextStyles(Document.Style.Builder builderForValue)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addTextStyles(Document.Style value)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addTextStyles(int index,
Document.Style.Builder builderForValue)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
addTextStyles(int index,
Document.Style value)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Style.Builder |
addTextStylesBuilder()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Style.Builder |
addTextStylesBuilder(int index)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document |
build() |
Document |
buildPartial() |
Document.Builder |
clear() |
Document.Builder |
clearContent()
Inline document content, represented as a stream of bytes.
|
Document.Builder |
clearEntities()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
clearEntityRelations()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
clearError()
Any error that occurred while processing this document.
|
Document.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Document.Builder |
clearMimeType()
An IANA published MIME type (also referred to as media type).
|
Document.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Document.Builder |
clearPages()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
clearShardInfo()
Information about the sharding if this document is sharded part of a larger
document.
|
Document.Builder |
clearSource() |
Document.Builder |
clearText()
UTF-8 encoded text in reading order from the document.
|
Document.Builder |
clearTextStyles()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
clearUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
Document.Builder |
clone() |
com.google.protobuf.ByteString |
getContent()
Inline document content, represented as a stream of bytes.
|
Document |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Document.Entity |
getEntities(int index)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Entity.Builder |
getEntitiesBuilder(int index)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<Document.Entity.Builder> |
getEntitiesBuilderList()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
int |
getEntitiesCount()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<Document.Entity> |
getEntitiesList()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.EntityOrBuilder |
getEntitiesOrBuilder(int index)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<? extends Document.EntityOrBuilder> |
getEntitiesOrBuilderList()
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.EntityRelation |
getEntityRelations(int index)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.EntityRelation.Builder |
getEntityRelationsBuilder(int index)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
List<Document.EntityRelation.Builder> |
getEntityRelationsBuilderList()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
int |
getEntityRelationsCount()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
List<Document.EntityRelation> |
getEntityRelationsList()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.EntityRelationOrBuilder |
getEntityRelationsOrBuilder(int index)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
List<? extends Document.EntityRelationOrBuilder> |
getEntityRelationsOrBuilderList()
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
com.google.rpc.Status |
getError()
Any error that occurred while processing this document.
|
com.google.rpc.Status.Builder |
getErrorBuilder()
Any error that occurred while processing this document.
|
com.google.rpc.StatusOrBuilder |
getErrorOrBuilder()
Any error that occurred while processing this document.
|
String |
getMimeType()
An IANA published MIME type (also referred to as media type).
|
com.google.protobuf.ByteString |
getMimeTypeBytes()
An IANA published MIME type (also referred to as media type).
|
Document.Page |
getPages(int index)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Page.Builder |
getPagesBuilder(int index)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
List<Document.Page.Builder> |
getPagesBuilderList()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
int |
getPagesCount()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
List<Document.Page> |
getPagesList()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.PageOrBuilder |
getPagesOrBuilder(int index)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
List<? extends Document.PageOrBuilder> |
getPagesOrBuilderList()
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.ShardInfo |
getShardInfo()
Information about the sharding if this document is sharded part of a larger
document.
|
Document.ShardInfo.Builder |
getShardInfoBuilder()
Information about the sharding if this document is sharded part of a larger
document.
|
Document.ShardInfoOrBuilder |
getShardInfoOrBuilder()
Information about the sharding if this document is sharded part of a larger
document.
|
Document.SourceCase |
getSourceCase() |
String |
getText()
UTF-8 encoded text in reading order from the document.
|
com.google.protobuf.ByteString |
getTextBytes()
UTF-8 encoded text in reading order from the document.
|
Document.Style |
getTextStyles(int index)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Style.Builder |
getTextStylesBuilder(int index)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<Document.Style.Builder> |
getTextStylesBuilderList()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
int |
getTextStylesCount()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<Document.Style> |
getTextStylesList()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.StyleOrBuilder |
getTextStylesOrBuilder(int index)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
List<? extends Document.StyleOrBuilder> |
getTextStylesOrBuilderList()
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
String |
getUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
com.google.protobuf.ByteString |
getUriBytes()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
boolean |
hasContent()
Inline document content, represented as a stream of bytes.
|
boolean |
hasError()
Any error that occurred while processing this document.
|
boolean |
hasShardInfo()
Information about the sharding if this document is sharded part of a larger
document.
|
boolean |
hasUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Document.Builder |
mergeError(com.google.rpc.Status value)
Any error that occurred while processing this document.
|
Document.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Document.Builder |
mergeFrom(Document other) |
Document.Builder |
mergeFrom(com.google.protobuf.Message other) |
Document.Builder |
mergeShardInfo(Document.ShardInfo value)
Information about the sharding if this document is sharded part of a larger
document.
|
Document.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Document.Builder |
removeEntities(int index)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
removeEntityRelations(int index)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
removePages(int index)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
removeTextStyles(int index)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
setContent(com.google.protobuf.ByteString value)
Inline document content, represented as a stream of bytes.
|
Document.Builder |
setEntities(int index,
Document.Entity.Builder builderForValue)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
setEntities(int index,
Document.Entity value)
A list of entities detected on
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
setEntityRelations(int index,
Document.EntityRelation.Builder builderForValue)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
setEntityRelations(int index,
Document.EntityRelation value)
Relationship among
[Document.entities][google.cloud.documentai.v1beta1.Document.entities].
|
Document.Builder |
setError(com.google.rpc.Status.Builder builderForValue)
Any error that occurred while processing this document.
|
Document.Builder |
setError(com.google.rpc.Status value)
Any error that occurred while processing this document.
|
Document.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Document.Builder |
setMimeType(String value)
An IANA published MIME type (also referred to as media type).
|
Document.Builder |
setMimeTypeBytes(com.google.protobuf.ByteString value)
An IANA published MIME type (also referred to as media type).
|
Document.Builder |
setPages(int index,
Document.Page.Builder builderForValue)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
setPages(int index,
Document.Page value)
Visual page layout for the
[Document][google.cloud.documentai.v1beta1.Document].
|
Document.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Document.Builder |
setShardInfo(Document.ShardInfo.Builder builderForValue)
Information about the sharding if this document is sharded part of a larger
document.
|
Document.Builder |
setShardInfo(Document.ShardInfo value)
Information about the sharding if this document is sharded part of a larger
document.
|
Document.Builder |
setText(String value)
UTF-8 encoded text in reading order from the document.
|
Document.Builder |
setTextBytes(com.google.protobuf.ByteString value)
UTF-8 encoded text in reading order from the document.
|
Document.Builder |
setTextStyles(int index,
Document.Style.Builder builderForValue)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
setTextStyles(int index,
Document.Style value)
Styles for the
[Document.text][google.cloud.documentai.v1beta1.Document.text].
|
Document.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Document.Builder |
setUri(String value)
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
Document.Builder |
setUriBytes(com.google.protobuf.ByteString value)
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Document build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Document buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Document.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>public Document.Builder mergeFrom(Document other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public Document.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>IOExceptionpublic Document.SourceCase getSourceCase()
getSourceCase in interface DocumentOrBuilderpublic Document.Builder clearSource()
public boolean hasUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;hasUri in interface DocumentOrBuilderpublic String getUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;getUri in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getUriBytes()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;getUriBytes in interface DocumentOrBuilderpublic Document.Builder setUri(String value)
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;value - The uri to set.public Document.Builder clearUri()
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;public Document.Builder setUriBytes(com.google.protobuf.ByteString value)
Currently supports Google Cloud Storage URI of the form
`gs://bucket_name/object_name`. Object versioning is not supported.
See [Google Cloud Storage Request
URIs](https://cloud.google.com/storage/docs/reference-uris) for more
info.
string uri = 1;value - The bytes for uri to set.public boolean hasContent()
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;hasContent in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getContent()
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;getContent in interface DocumentOrBuilderpublic Document.Builder setContent(com.google.protobuf.ByteString value)
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;value - The content to set.public Document.Builder clearContent()
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;public String getMimeType()
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;getMimeType in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getMimeTypeBytes()
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;getMimeTypeBytes in interface DocumentOrBuilderpublic Document.Builder setMimeType(String value)
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;value - The mimeType to set.public Document.Builder clearMimeType()
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;public Document.Builder setMimeTypeBytes(com.google.protobuf.ByteString value)
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;value - The bytes for mimeType to set.public String getText()
UTF-8 encoded text in reading order from the document.
string text = 4;getText in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getTextBytes()
UTF-8 encoded text in reading order from the document.
string text = 4;getTextBytes in interface DocumentOrBuilderpublic Document.Builder setText(String value)
UTF-8 encoded text in reading order from the document.
string text = 4;value - The text to set.public Document.Builder clearText()
UTF-8 encoded text in reading order from the document.
string text = 4;public Document.Builder setTextBytes(com.google.protobuf.ByteString value)
UTF-8 encoded text in reading order from the document.
string text = 4;value - The bytes for text to set.public List<Document.Style> getTextStylesList()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;getTextStylesList in interface DocumentOrBuilderpublic int getTextStylesCount()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;getTextStylesCount in interface DocumentOrBuilderpublic Document.Style getTextStyles(int index)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;getTextStyles in interface DocumentOrBuilderpublic Document.Builder setTextStyles(int index, Document.Style value)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder setTextStyles(int index, Document.Style.Builder builderForValue)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder addTextStyles(Document.Style value)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder addTextStyles(int index, Document.Style value)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder addTextStyles(Document.Style.Builder builderForValue)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder addTextStyles(int index, Document.Style.Builder builderForValue)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder addAllTextStyles(Iterable<? extends Document.Style> values)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder clearTextStyles()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Builder removeTextStyles(int index)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Style.Builder getTextStylesBuilder(int index)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.StyleOrBuilder getTextStylesOrBuilder(int index)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;getTextStylesOrBuilder in interface DocumentOrBuilderpublic List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;getTextStylesOrBuilderList in interface DocumentOrBuilderpublic Document.Style.Builder addTextStylesBuilder()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public Document.Style.Builder addTextStylesBuilder(int index)
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public List<Document.Style.Builder> getTextStylesBuilderList()
Styles for the [Document.text][google.cloud.documentai.v1beta1.Document.text].
repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;public List<Document.Page> getPagesList()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;getPagesList in interface DocumentOrBuilderpublic int getPagesCount()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;getPagesCount in interface DocumentOrBuilderpublic Document.Page getPages(int index)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;getPages in interface DocumentOrBuilderpublic Document.Builder setPages(int index, Document.Page value)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder setPages(int index, Document.Page.Builder builderForValue)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder addPages(Document.Page value)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder addPages(int index, Document.Page value)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder addPages(Document.Page.Builder builderForValue)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder addPages(int index, Document.Page.Builder builderForValue)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder addAllPages(Iterable<? extends Document.Page> values)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder clearPages()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Builder removePages(int index)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Page.Builder getPagesBuilder(int index)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.PageOrBuilder getPagesOrBuilder(int index)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;getPagesOrBuilder in interface DocumentOrBuilderpublic List<? extends Document.PageOrBuilder> getPagesOrBuilderList()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;getPagesOrBuilderList in interface DocumentOrBuilderpublic Document.Page.Builder addPagesBuilder()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public Document.Page.Builder addPagesBuilder(int index)
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public List<Document.Page.Builder> getPagesBuilderList()
Visual page layout for the [Document][google.cloud.documentai.v1beta1.Document].
repeated .google.cloud.documentai.v1beta1.Document.Page pages = 6;public List<Document.Entity> getEntitiesList()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;getEntitiesList in interface DocumentOrBuilderpublic int getEntitiesCount()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;getEntitiesCount in interface DocumentOrBuilderpublic Document.Entity getEntities(int index)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;getEntities in interface DocumentOrBuilderpublic Document.Builder setEntities(int index, Document.Entity value)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder setEntities(int index, Document.Entity.Builder builderForValue)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder addEntities(Document.Entity value)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder addEntities(int index, Document.Entity value)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder addEntities(Document.Entity.Builder builderForValue)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder addEntities(int index, Document.Entity.Builder builderForValue)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder addAllEntities(Iterable<? extends Document.Entity> values)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder clearEntities()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Builder removeEntities(int index)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Entity.Builder getEntitiesBuilder(int index)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.EntityOrBuilder getEntitiesOrBuilder(int index)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;getEntitiesOrBuilder in interface DocumentOrBuilderpublic List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;getEntitiesOrBuilderList in interface DocumentOrBuilderpublic Document.Entity.Builder addEntitiesBuilder()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public Document.Entity.Builder addEntitiesBuilder(int index)
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public List<Document.Entity.Builder> getEntitiesBuilderList()
A list of entities detected on [Document.text][google.cloud.documentai.v1beta1.Document.text]. For document shards, entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1beta1.Document.Entity entities = 7;public List<Document.EntityRelation> getEntityRelationsList()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
getEntityRelationsList in interface DocumentOrBuilderpublic int getEntityRelationsCount()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
getEntityRelationsCount in interface DocumentOrBuilderpublic Document.EntityRelation getEntityRelations(int index)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
getEntityRelations in interface DocumentOrBuilderpublic Document.Builder setEntityRelations(int index, Document.EntityRelation value)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder setEntityRelations(int index, Document.EntityRelation.Builder builderForValue)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder addEntityRelations(Document.EntityRelation value)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder addEntityRelations(int index, Document.EntityRelation value)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder addEntityRelations(Document.EntityRelation.Builder builderForValue)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder addEntityRelations(int index, Document.EntityRelation.Builder builderForValue)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder addAllEntityRelations(Iterable<? extends Document.EntityRelation> values)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder clearEntityRelations()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.Builder removeEntityRelations(int index)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.EntityRelation.Builder getEntityRelationsBuilder(int index)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
getEntityRelationsOrBuilder in interface DocumentOrBuilderpublic List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
getEntityRelationsOrBuilderList in interface DocumentOrBuilderpublic Document.EntityRelation.Builder addEntityRelationsBuilder()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public Document.EntityRelation.Builder addEntityRelationsBuilder(int index)
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
public List<Document.EntityRelation.Builder> getEntityRelationsBuilderList()
Relationship among [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
repeated .google.cloud.documentai.v1beta1.Document.EntityRelation entity_relations = 8;
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.v1beta1.Document.ShardInfo shard_info = 9;hasShardInfo in interface DocumentOrBuilderpublic 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.v1beta1.Document.ShardInfo shard_info = 9;getShardInfo in interface DocumentOrBuilderpublic Document.Builder setShardInfo(Document.ShardInfo value)
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.v1beta1.Document.ShardInfo shard_info = 9;public Document.Builder setShardInfo(Document.ShardInfo.Builder builderForValue)
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.v1beta1.Document.ShardInfo shard_info = 9;public Document.Builder mergeShardInfo(Document.ShardInfo value)
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.v1beta1.Document.ShardInfo shard_info = 9;public Document.Builder 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.v1beta1.Document.ShardInfo shard_info = 9;public Document.ShardInfo.Builder 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.v1beta1.Document.ShardInfo shard_info = 9;public 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.v1beta1.Document.ShardInfo shard_info = 9;getShardInfoOrBuilder in interface DocumentOrBuilderpublic boolean hasError()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;hasError in interface DocumentOrBuilderpublic com.google.rpc.Status getError()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;getError in interface DocumentOrBuilderpublic Document.Builder setError(com.google.rpc.Status value)
Any error that occurred while processing this document.
.google.rpc.Status error = 10;public Document.Builder setError(com.google.rpc.Status.Builder builderForValue)
Any error that occurred while processing this document.
.google.rpc.Status error = 10;public Document.Builder mergeError(com.google.rpc.Status value)
Any error that occurred while processing this document.
.google.rpc.Status error = 10;public Document.Builder clearError()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;public com.google.rpc.Status.Builder getErrorBuilder()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;getErrorOrBuilder in interface DocumentOrBuilderpublic final Document.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>public final Document.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>Copyright © 2024 Google LLC. All rights reserved.