Package com.google.cloud.documentai.v1

Class Document

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Document
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Document extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • URI_FIELD_NUMBER

      public static final int URI_FIELD_NUMBER
      See Also:

    • CONTENT_FIELD_NUMBER

      public static final int CONTENT_FIELD_NUMBER
      See Also:

    • DOCID_FIELD_NUMBER

      public static final int DOCID_FIELD_NUMBER
      See Also:

    • MIME_TYPE_FIELD_NUMBER

      public static final int MIME_TYPE_FIELD_NUMBER
      See Also:

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • TEXT_STYLES_FIELD_NUMBER

      public static final int TEXT_STYLES_FIELD_NUMBER
      See Also:

    • PAGES_FIELD_NUMBER

      public static final int PAGES_FIELD_NUMBER
      See Also:

    • ENTITIES_FIELD_NUMBER

      public static final int ENTITIES_FIELD_NUMBER
      See Also:

    • ENTITY_RELATIONS_FIELD_NUMBER

      public static final int ENTITY_RELATIONS_FIELD_NUMBER
      See Also:

    • TEXT_CHANGES_FIELD_NUMBER

      public static final int TEXT_CHANGES_FIELD_NUMBER
      See Also:

    • SHARD_INFO_FIELD_NUMBER

      public static final int SHARD_INFO_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • REVISIONS_FIELD_NUMBER

      public static final int REVISIONS_FIELD_NUMBER
      See Also:

    • DOCUMENT_LAYOUT_FIELD_NUMBER

      public static final int DOCUMENT_LAYOUT_FIELD_NUMBER
      See Also:

    • CHUNKED_DOCUMENT_FIELD_NUMBER

      public static final int CHUNKED_DOCUMENT_FIELD_NUMBER
      See Also:

    • BLOB_ASSETS_FIELD_NUMBER

      public static final int BLOB_ASSETS_FIELD_NUMBER
      See Also:

    • ENTITY_VALIDATION_OUTPUT_FIELD_NUMBER

      public static final int ENTITY_VALIDATION_OUTPUT_FIELD_NUMBER
      See Also:

    • ENTITIES_REVISIONS_FIELD_NUMBER

      public static final int ENTITIES_REVISIONS_FIELD_NUMBER
      See Also:

    • ENTITIES_REVISION_ID_FIELD_NUMBER

      public static final int ENTITIES_REVISION_ID_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSourceCase

      public Document.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface DocumentOrBuilder

    • 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:
      hasUri in interface DocumentOrBuilder
      Returns:
      Whether the uri field is set.

    • getUri

      public 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];
      Specified by:
      getUri in interface DocumentOrBuilder
      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:
      getUriBytes in interface DocumentOrBuilder
      Returns:
      The bytes for uri.

    • 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:
      hasContent in interface DocumentOrBuilder
      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:
      getContent in interface DocumentOrBuilder
      Returns:
      The content.

    • getDocid

      public String getDocid()
       Optional. An internal identifier for document. Should be loggable (no PII).
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDocid in interface DocumentOrBuilder
      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:
      getDocidBytes in interface DocumentOrBuilder
      Returns:
      The bytes for docid.

    • getMimeType

      public String getMimeType()
       An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
      string mime_type = 3;
      Specified by:
      getMimeType in interface DocumentOrBuilder
      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:
      getMimeTypeBytes in interface DocumentOrBuilder
      Returns:
      The bytes for mimeType.

    • getText

      public String getText()
       Optional. UTF-8 encoded text in reading order from the document.
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getText in interface DocumentOrBuilder
      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:
      getTextBytes in interface DocumentOrBuilder
      Returns:
      The bytes for text.

    • getTextStylesList

      @Deprecated public List<Document.Style> 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:
      getTextStylesList in interface DocumentOrBuilder

    • getTextStylesOrBuilderList

      @Deprecated public List<? extends Document.StyleOrBuilder> 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:
      getTextStylesOrBuilderList in interface DocumentOrBuilder

    • getTextStylesCount

      @Deprecated public int 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:
      getTextStylesCount in interface DocumentOrBuilder

    • getTextStyles

      @Deprecated public Document.Style getTextStyles(int index)
      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:
      getTextStyles in interface DocumentOrBuilder

    • getTextStylesOrBuilder

      @Deprecated public Document.StyleOrBuilder getTextStylesOrBuilder(int index)
      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:
      getTextStylesOrBuilder in interface DocumentOrBuilder

    • getPagesList

      public List<Document.Page> getPagesList()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
      Specified by:
      getPagesList in interface DocumentOrBuilder

    • getPagesOrBuilderList

      public List<? extends Document.PageOrBuilder> getPagesOrBuilderList()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
      Specified by:
      getPagesOrBuilderList in interface DocumentOrBuilder

    • 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:
      getPagesCount in interface DocumentOrBuilder

    • getPages

      public Document.Page getPages(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
      Specified by:
      getPages in interface DocumentOrBuilder

    • getPagesOrBuilder

      public Document.PageOrBuilder getPagesOrBuilder(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
      Specified by:
      getPagesOrBuilder in interface DocumentOrBuilder

    • getEntitiesList

      public List<Document.Entity> 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:
      getEntitiesList in interface DocumentOrBuilder

    • getEntitiesOrBuilderList

      public List<? extends Document.EntityOrBuilder> 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:
      getEntitiesOrBuilderList in interface DocumentOrBuilder

    • 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:
      getEntitiesCount in interface DocumentOrBuilder

    • getEntities

      public Document.Entity getEntities(int index)
       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:
      getEntities in interface DocumentOrBuilder

    • getEntitiesOrBuilder

      public Document.EntityOrBuilder getEntitiesOrBuilder(int index)
       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:
      getEntitiesOrBuilder in interface DocumentOrBuilder

    • getEntityRelationsList

      public List<Document.EntityRelation> getEntityRelationsList()
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
      Specified by:
      getEntityRelationsList in interface DocumentOrBuilder

    • getEntityRelationsOrBuilderList

      public List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
      Specified by:
      getEntityRelationsOrBuilderList in interface DocumentOrBuilder

    • 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:
      getEntityRelationsCount in interface DocumentOrBuilder

    • getEntityRelations

      public Document.EntityRelation getEntityRelations(int index)
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
      Specified by:
      getEntityRelations in interface DocumentOrBuilder

    • getEntityRelationsOrBuilder

      public Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
      Specified by:
      getEntityRelationsOrBuilder in interface DocumentOrBuilder

    • getTextChangesList

      public List<Document.TextChange> 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:
      getTextChangesList in interface DocumentOrBuilder

    • getTextChangesOrBuilderList

      public List<? extends Document.TextChangeOrBuilder> 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:
      getTextChangesOrBuilderList in interface DocumentOrBuilder

    • 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:
      getTextChangesCount in interface DocumentOrBuilder

    • getTextChanges

      public Document.TextChange getTextChanges(int index)
       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:
      getTextChanges in interface DocumentOrBuilder

    • getTextChangesOrBuilder

      public Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)
       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:
      getTextChangesOrBuilder in interface DocumentOrBuilder

    • 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:
      hasShardInfo in interface DocumentOrBuilder
      Returns:
      Whether the shardInfo field is set.

    • getShardInfo

      public 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.v1.Document.ShardInfo shard_info = 9;
      Specified by:
      getShardInfo in interface DocumentOrBuilder
      Returns:
      The shardInfo.

    • getShardInfoOrBuilder

      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.v1.Document.ShardInfo shard_info = 9;
      Specified by:
      getShardInfoOrBuilder in interface DocumentOrBuilder

    • hasError

      public boolean hasError()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;
      Specified by:
      hasError in interface DocumentOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;
      Specified by:
      getError in interface DocumentOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;
      Specified by:
      getErrorOrBuilder in interface DocumentOrBuilder

    • getRevisionsList

      public List<Document.Revision> getRevisionsList()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
      Specified by:
      getRevisionsList in interface DocumentOrBuilder

    • getRevisionsOrBuilderList

      public List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
      Specified by:
      getRevisionsOrBuilderList in interface DocumentOrBuilder

    • getRevisionsCount

      public int getRevisionsCount()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
      Specified by:
      getRevisionsCount in interface DocumentOrBuilder

    • getRevisions

      public Document.Revision getRevisions(int index)
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
      Specified by:
      getRevisions in interface DocumentOrBuilder

    • getRevisionsOrBuilder

      public Document.RevisionOrBuilder getRevisionsOrBuilder(int index)
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
      Specified by:
      getRevisionsOrBuilder in interface DocumentOrBuilder

    • hasDocumentLayout

      public boolean hasDocumentLayout()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Specified by:
      hasDocumentLayout in interface DocumentOrBuilder
      Returns:
      Whether the documentLayout field is set.

    • getDocumentLayout

      public Document.DocumentLayout getDocumentLayout()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Specified by:
      getDocumentLayout in interface DocumentOrBuilder
      Returns:
      The documentLayout.

    • getDocumentLayoutOrBuilder

      public Document.DocumentLayoutOrBuilder getDocumentLayoutOrBuilder()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Specified by:
      getDocumentLayoutOrBuilder in interface DocumentOrBuilder

    • hasChunkedDocument

      public boolean hasChunkedDocument()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
      Specified by:
      hasChunkedDocument in interface DocumentOrBuilder
      Returns:
      Whether the chunkedDocument field is set.

    • getChunkedDocument

      public Document.ChunkedDocument getChunkedDocument()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
      Specified by:
      getChunkedDocument in interface DocumentOrBuilder
      Returns:
      The chunkedDocument.

    • getChunkedDocumentOrBuilder

      public Document.ChunkedDocumentOrBuilder getChunkedDocumentOrBuilder()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
      Specified by:
      getChunkedDocumentOrBuilder in interface DocumentOrBuilder

    • getBlobAssetsList

      public List<Document.BlobAsset> getBlobAssetsList()
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, 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:
      getBlobAssetsList in interface DocumentOrBuilder

    • getBlobAssetsOrBuilderList

      public List<? extends Document.BlobAssetOrBuilder> getBlobAssetsOrBuilderList()
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, 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:
      getBlobAssetsOrBuilderList in interface DocumentOrBuilder

    • 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:
      getBlobAssetsCount in interface DocumentOrBuilder

    • getBlobAssets

      public Document.BlobAsset getBlobAssets(int index)
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, 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:
      getBlobAssets in interface DocumentOrBuilder

    • getBlobAssetsOrBuilder

      public Document.BlobAssetOrBuilder getBlobAssetsOrBuilder(int index)
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, 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:
      getBlobAssetsOrBuilder in interface DocumentOrBuilder

    • 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:
      hasEntityValidationOutput in interface DocumentOrBuilder
      Returns:
      Whether the entityValidationOutput field is set.

    • getEntityValidationOutput

      public Document.EntityValidationOutput 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:
      getEntityValidationOutput in interface DocumentOrBuilder
      Returns:
      The entityValidationOutput.

    • getEntityValidationOutputOrBuilder

      public Document.EntityValidationOutputOrBuilder 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:
      getEntityValidationOutputOrBuilder in interface DocumentOrBuilder

    • getEntitiesRevisionsList

      public List<Document.EntitiesRevision> 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:
      getEntitiesRevisionsList in interface DocumentOrBuilder

    • getEntitiesRevisionsOrBuilderList

      public List<? extends Document.EntitiesRevisionOrBuilder> 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:
      getEntitiesRevisionsOrBuilderList in interface DocumentOrBuilder

    • 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:
      getEntitiesRevisionsCount in interface DocumentOrBuilder

    • getEntitiesRevisions

      public Document.EntitiesRevision getEntitiesRevisions(int index)
       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:
      getEntitiesRevisions in interface DocumentOrBuilder

    • getEntitiesRevisionsOrBuilder

      public Document.EntitiesRevisionOrBuilder getEntitiesRevisionsOrBuilder(int index)
       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:
      getEntitiesRevisionsOrBuilder in interface DocumentOrBuilder

    • getEntitiesRevisionId

      public String 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:
      getEntitiesRevisionId in interface DocumentOrBuilder
      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:
      getEntitiesRevisionIdBytes in interface DocumentOrBuilder
      Returns:
      The bytes for entitiesRevisionId.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Document parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Document.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Document.Builder newBuilder()

    • newBuilder

      public static Document.Builder newBuilder(Document prototype)

    • toBuilder

      public Document.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Document.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document> parser()

    • getParserForType

      public com.google.protobuf.Parser<Document> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Document getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder