com.google.cloud.documentai.v1beta1

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() Inline document content, represented as a stream of bytes.
Document.Entity	getEntities(int index) 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].
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.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].
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.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].
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`.

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()

 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;

Returns:

Whether the uri field is set.

getUri

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;

Returns:

The uri.

getUriBytes

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;

Returns:

The bytes for uri.

hasContent

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;

Returns:

Whether the content field is set.

getContent

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;

Returns:

The content.

getMimeType

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;

Returns:

The mimeType.

getMimeTypeBytes

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;

Returns:

The bytes for mimeType.

getText

String getText()

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

string text = 4;

Returns:

The text.

getTextBytes

com.google.protobuf.ByteString getTextBytes()

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

string text = 4;

Returns:

The bytes for text.

getTextStylesList

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;

getTextStyles

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;

getTextStylesCount

int getTextStylesCount()

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

repeated .google.cloud.documentai.v1beta1.Document.Style text_styles = 5;

getTextStylesOrBuilderList

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;

getTextStylesOrBuilder

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;

getPagesList

List<Document.Page> getPagesList()

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

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

getPages

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;

getPagesCount

int getPagesCount()

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

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

getPagesOrBuilderList

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;

getPagesOrBuilder

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;

getEntitiesList

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;

getEntities

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;

getEntitiesCount

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;

getEntitiesOrBuilderList

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;

getEntitiesOrBuilder

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;

getEntityRelationsList

List<Document.EntityRelation> getEntityRelationsList()

 Relationship among
 [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
 

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

getEntityRelations

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;

getEntityRelationsCount

int getEntityRelationsCount()

 Relationship among
 [Document.entities][google.cloud.documentai.v1beta1.Document.entities].
 

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

getEntityRelationsOrBuilderList

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;

getEntityRelationsOrBuilder

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;

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

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;

getSourceCase

Document.SourceCase getSourceCase()