com.google.cloud.documentai.v1beta2

Interface DocumentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document, Document.Builder

public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getContent() Optional.
Document.Entity	getEntities(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
int	getEntitiesCount() A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
List<Document.Entity>	getEntitiesList() A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
Document.EntityOrBuilder	getEntitiesOrBuilder(int index) A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
List<? extends Document.EntityOrBuilder>	getEntitiesOrBuilderList() A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
Document.EntityRelation	getEntityRelations(int index) Placeholder.
int	getEntityRelationsCount() Placeholder.
List<Document.EntityRelation>	getEntityRelationsList() Placeholder.
Document.EntityRelationOrBuilder	getEntityRelationsOrBuilder(int index) Placeholder.
List<? extends Document.EntityRelationOrBuilder>	getEntityRelationsOrBuilderList() Placeholder.
com.google.rpc.Status	getError() Any error that occurred while processing this document.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Any error that occurred while processing this document.
Document.Label	getLabels(int index) [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
int	getLabelsCount() [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
List<Document.Label>	getLabelsList() [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
Document.LabelOrBuilder	getLabelsOrBuilder(int index) [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
List<? extends Document.LabelOrBuilder>	getLabelsOrBuilderList() [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
String	getMimeType() An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
com.google.protobuf.ByteString	getMimeTypeBytes() An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
Document.Page	getPages(int index) Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
int	getPagesCount() Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
List<Document.Page>	getPagesList() Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
Document.PageOrBuilder	getPagesOrBuilder(int index) Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
List<? extends Document.PageOrBuilder>	getPagesOrBuilderList() Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
Document.Revision	getRevisions(int index) Placeholder.
int	getRevisionsCount() Placeholder.
List<Document.Revision>	getRevisionsList() Placeholder.
Document.RevisionOrBuilder	getRevisionsOrBuilder(int index) Placeholder.
List<? extends Document.RevisionOrBuilder>	getRevisionsOrBuilderList() Placeholder.
Document.ShardInfo	getShardInfo() 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() Optional.
com.google.protobuf.ByteString	getTextBytes() Optional.
Document.TextChange	getTextChanges(int index) Placeholder.
int	getTextChangesCount() Placeholder.
List<Document.TextChange>	getTextChangesList() Placeholder.
Document.TextChangeOrBuilder	getTextChangesOrBuilder(int index) Placeholder.
List<? extends Document.TextChangeOrBuilder>	getTextChangesOrBuilderList() Placeholder.
Document.Style	getTextStyles(int index) Deprecated.
int	getTextStylesCount() Deprecated.
List<Document.Style>	getTextStylesList() Deprecated.
Document.StyleOrBuilder	getTextStylesOrBuilder(int index) Deprecated.
List<? extends Document.StyleOrBuilder>	getTextStylesOrBuilderList() Deprecated.
String	getUri() Optional.
com.google.protobuf.ByteString	getUriBytes() Optional.
boolean	hasContent() Optional.
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() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasUri

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

Returns:

Whether the uri field is set.

getUri

String getUri()

 Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
 

string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The uri.

getUriBytes

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

Returns:

The bytes for uri.

hasContent

boolean hasContent()

 Optional. Inline document content, represented as a stream of bytes.
 Note: As with all `bytes` fields, protobuffers use a pure binary
 representation, whereas JSON representations use base64.
 

bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the content field is set.

getContent

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

Returns:

The content.

getMimeType

String getMimeType()

 An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
 

string mime_type = 3;

Returns:

The mimeType.

getMimeTypeBytes

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;

Returns:

The bytes for mimeType.

getText

String getText()

 Optional. UTF-8 encoded text in reading order from the document.
 

string text = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The text.

getTextBytes

com.google.protobuf.ByteString getTextBytes()

 Optional. UTF-8 encoded text in reading order from the document.
 

string text = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for text.

getTextStylesList

@Deprecated
List<Document.Style> getTextStylesList()

Deprecated.

 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];

getTextStyles

@Deprecated
Document.Style getTextStyles(int index)

Deprecated.

 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];

getTextStylesCount

@Deprecated
int getTextStylesCount()

Deprecated.

 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];

getTextStylesOrBuilderList

@Deprecated
List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()

Deprecated.

 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];

getTextStylesOrBuilder

@Deprecated
Document.StyleOrBuilder getTextStylesOrBuilder(int index)

Deprecated.

 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];

getPagesList

List<Document.Page> getPagesList()

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

getPages

Document.Page getPages(int index)

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

getPagesCount

int getPagesCount()

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

getPagesOrBuilderList

List<? extends Document.PageOrBuilder> getPagesOrBuilderList()

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

getPagesOrBuilder

Document.PageOrBuilder getPagesOrBuilder(int index)

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

getEntitiesList

List<Document.Entity> getEntitiesList()

 A list of entities detected on
 [Document.text][google.cloud.documentai.v1beta2.Document.text]. For
 document shards, entities in this list may cross shard boundaries.
 

repeated .google.cloud.documentai.v1beta2.Document.Entity entities = 7;

getEntities

Document.Entity getEntities(int index)

 A list of entities detected on
 [Document.text][google.cloud.documentai.v1beta2.Document.text]. For
 document shards, entities in this list may cross shard boundaries.
 

repeated .google.cloud.documentai.v1beta2.Document.Entity entities = 7;

getEntitiesCount

int getEntitiesCount()

 A list of entities detected on
 [Document.text][google.cloud.documentai.v1beta2.Document.text]. For
 document shards, entities in this list may cross shard boundaries.
 

repeated .google.cloud.documentai.v1beta2.Document.Entity entities = 7;

getEntitiesOrBuilderList

List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()

 A list of entities detected on
 [Document.text][google.cloud.documentai.v1beta2.Document.text]. For
 document shards, entities in this list may cross shard boundaries.
 

repeated .google.cloud.documentai.v1beta2.Document.Entity entities = 7;

getEntitiesOrBuilder

Document.EntityOrBuilder getEntitiesOrBuilder(int index)

 A list of entities detected on
 [Document.text][google.cloud.documentai.v1beta2.Document.text]. For
 document shards, entities in this list may cross shard boundaries.
 

repeated .google.cloud.documentai.v1beta2.Document.Entity entities = 7;

getEntityRelationsList

List<Document.EntityRelation> getEntityRelationsList()

 Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
 

repeated .google.cloud.documentai.v1beta2.Document.EntityRelation entity_relations = 8;

getEntityRelations

Document.EntityRelation getEntityRelations(int index)

 Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
 

repeated .google.cloud.documentai.v1beta2.Document.EntityRelation entity_relations = 8;

getEntityRelationsCount

int getEntityRelationsCount()

 Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
 

repeated .google.cloud.documentai.v1beta2.Document.EntityRelation entity_relations = 8;

getEntityRelationsOrBuilderList

List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()

 Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
 

repeated .google.cloud.documentai.v1beta2.Document.EntityRelation entity_relations = 8;

getEntityRelationsOrBuilder

Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)

 Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1beta2.Document.entities].
 

repeated .google.cloud.documentai.v1beta2.Document.EntityRelation entity_relations = 8;

getTextChangesList

List<Document.TextChange> getTextChangesList()

 Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1beta2.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.v1beta2.Document.TextChange text_changes = 14;

getTextChanges

Document.TextChange getTextChanges(int index)

 Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1beta2.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.v1beta2.Document.TextChange text_changes = 14;

getTextChangesCount

int getTextChangesCount()

 Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1beta2.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.v1beta2.Document.TextChange text_changes = 14;

getTextChangesOrBuilderList

List<? extends Document.TextChangeOrBuilder> getTextChangesOrBuilderList()

 Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1beta2.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.v1beta2.Document.TextChange text_changes = 14;

getTextChangesOrBuilder

Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)

 Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1beta2.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.v1beta2.Document.TextChange text_changes = 14;

hasShardInfo

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.v1beta2.Document.ShardInfo shard_info = 9;

Returns:

Whether the shardInfo field is set.

getShardInfo

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.v1beta2.Document.ShardInfo shard_info = 9;

Returns:

The shardInfo.

getShardInfoOrBuilder

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.v1beta2.Document.ShardInfo shard_info = 9;

getLabelsList

List<Document.Label> getLabelsList()

 [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Label labels = 11;

getLabels

Document.Label getLabels(int index)

 [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Label labels = 11;

getLabelsCount

int getLabelsCount()

 [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Label labels = 11;

getLabelsOrBuilderList

List<? extends Document.LabelOrBuilder> getLabelsOrBuilderList()

 [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Label labels = 11;

getLabelsOrBuilder

Document.LabelOrBuilder getLabelsOrBuilder(int index)

 [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Label labels = 11;

hasError

boolean hasError()

 Any error that occurred while processing this document.
 

.google.rpc.Status error = 10;

Returns:

Whether the error field is set.

getError

com.google.rpc.Status getError()

 Any error that occurred while processing this document.
 

.google.rpc.Status error = 10;

Returns:

The error.

getErrorOrBuilder

com.google.rpc.StatusOrBuilder getErrorOrBuilder()

 Any error that occurred while processing this document.
 

.google.rpc.Status error = 10;

getRevisionsList

List<Document.Revision> getRevisionsList()

 Placeholder. Revision history of this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Revision revisions = 13;

getRevisions

Document.Revision getRevisions(int index)

 Placeholder. Revision history of this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Revision revisions = 13;

getRevisionsCount

int getRevisionsCount()

 Placeholder. Revision history of this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Revision revisions = 13;

getRevisionsOrBuilderList

List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()

 Placeholder. Revision history of this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Revision revisions = 13;

getRevisionsOrBuilder

Document.RevisionOrBuilder getRevisionsOrBuilder(int index)

 Placeholder. Revision history of this document.
 

repeated .google.cloud.documentai.v1beta2.Document.Revision revisions = 13;

getSourceCase

Document.SourceCase getSourceCase()