Class Document.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
com.google.cloud.documentai.v1.Document.Builder
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Document

public static final class Document.Builder extends com.google.protobuf.GeneratedMessage.Builder<Document.Builder> implements DocumentOrBuilder
 Document represents the canonical document resource in Document AI. It is an
 interchange format that provides insights into documents and allows for
 collaboration between users and Document AI to iterate and optimize for
 quality.
 
Protobuf type google.cloud.documentai.v1.Document
  • Method 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.Builder<Document.Builder>
    • clear

      public Document.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • getDefaultInstanceForType

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

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

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

      public Document.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
    • mergeFrom

      public Document.Builder mergeFrom(Document other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • mergeFrom

      public Document.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
      Throws:
      IOException
    • getSourceCase

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

      public Document.Builder clearSource()
    • hasUri

      public boolean hasUri()
       Optional. Currently supports Google Cloud Storage URI of the form
       `gs://bucket_name/object_name`. Object versioning is not supported.
       For more information, refer to [Google Cloud Storage Request
       URIs](https://cloud.google.com/storage/docs/reference-uris).
       
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      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.
    • setUri

      public Document.Builder setUri(String value)
       Optional. Currently supports Google Cloud Storage URI of the form
       `gs://bucket_name/object_name`. Object versioning is not supported.
       For more information, refer to [Google Cloud Storage Request
       URIs](https://cloud.google.com/storage/docs/reference-uris).
       
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The uri to set.
      Returns:
      This builder for chaining.
    • clearUri

      public Document.Builder clearUri()
       Optional. Currently supports Google Cloud Storage URI of the form
       `gs://bucket_name/object_name`. Object versioning is not supported.
       For more information, refer to [Google Cloud Storage Request
       URIs](https://cloud.google.com/storage/docs/reference-uris).
       
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setUriBytes

      public Document.Builder setUriBytes(com.google.protobuf.ByteString value)
       Optional. Currently supports Google Cloud Storage URI of the form
       `gs://bucket_name/object_name`. Object versioning is not supported.
       For more information, refer to [Google Cloud Storage Request
       URIs](https://cloud.google.com/storage/docs/reference-uris).
       
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for uri to set.
      Returns:
      This builder for chaining.
    • hasContent

      public boolean hasContent()
       Optional. Inline document content, represented as a stream of bytes.
       Note: As with all `bytes` fields, protobuffers use a pure binary
       representation, whereas JSON representations use base64.
       
      bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      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.
    • setContent

      public Document.Builder setContent(com.google.protobuf.ByteString value)
       Optional. Inline document content, represented as a stream of bytes.
       Note: As with all `bytes` fields, protobuffers use a pure binary
       representation, whereas JSON representations use base64.
       
      bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The content to set.
      Returns:
      This builder for chaining.
    • clearContent

      public Document.Builder clearContent()
       Optional. Inline document content, represented as a stream of bytes.
       Note: As with all `bytes` fields, protobuffers use a pure binary
       representation, whereas JSON representations use base64.
       
      bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getDocid

      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.
    • setDocid

      public Document.Builder setDocid(String value)
       Optional. An internal identifier for document. Should be loggable (no PII).
       
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The docid to set.
      Returns:
      This builder for chaining.
    • clearDocid

      public Document.Builder clearDocid()
       Optional. An internal identifier for document. Should be loggable (no PII).
       
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setDocidBytes

      public Document.Builder setDocidBytes(com.google.protobuf.ByteString value)
       Optional. An internal identifier for document. Should be loggable (no PII).
       
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for docid to set.
      Returns:
      This builder for chaining.
    • getMimeType

      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.
    • setMimeType

      public Document.Builder setMimeType(String value)
       An IANA published [media type (MIME
       type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
       
      string mime_type = 3;
      Parameters:
      value - The mimeType to set.
      Returns:
      This builder for chaining.
    • clearMimeType

      public Document.Builder clearMimeType()
       An IANA published [media type (MIME
       type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
       
      string mime_type = 3;
      Returns:
      This builder for chaining.
    • setMimeTypeBytes

      public Document.Builder setMimeTypeBytes(com.google.protobuf.ByteString value)
       An IANA published [media type (MIME
       type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
       
      string mime_type = 3;
      Parameters:
      value - The bytes for mimeType to set.
      Returns:
      This builder for chaining.
    • getText

      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.
    • setText

      public Document.Builder setText(String value)
       Optional. UTF-8 encoded text in reading order from the document.
       
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.
    • clearText

      public Document.Builder clearText()
       Optional. UTF-8 encoded text in reading order from the document.
       
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setTextBytes

      public Document.Builder setTextBytes(com.google.protobuf.ByteString value)
       Optional. UTF-8 encoded text in reading order from the document.
       
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.
    • getTextStylesList

      @Deprecated 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
    • 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
    • setTextStyles

      @Deprecated public Document.Builder setTextStyles(int index, Document.Style value)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • setTextStyles

      @Deprecated public Document.Builder setTextStyles(int index, Document.Style.Builder builderForValue)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addTextStyles

      @Deprecated public Document.Builder addTextStyles(Document.Style value)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addTextStyles

      @Deprecated public Document.Builder addTextStyles(int index, Document.Style value)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addTextStyles

      @Deprecated public Document.Builder addTextStyles(Document.Style.Builder builderForValue)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addTextStyles

      @Deprecated public Document.Builder addTextStyles(int index, Document.Style.Builder builderForValue)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addAllTextStyles

      @Deprecated public Document.Builder addAllTextStyles(Iterable<? extends Document.Style> values)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • clearTextStyles

      @Deprecated public Document.Builder clearTextStyles()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • removeTextStyles

      @Deprecated public Document.Builder removeTextStyles(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];
    • getTextStylesBuilder

      @Deprecated public Document.Style.Builder getTextStylesBuilder(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];
    • 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
    • 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
    • addTextStylesBuilder

      @Deprecated public Document.Style.Builder addTextStylesBuilder()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • addTextStylesBuilder

      @Deprecated public Document.Style.Builder addTextStylesBuilder(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];
    • getTextStylesBuilderList

      @Deprecated public List<Document.Style.Builder> getTextStylesBuilderList()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
       
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];
    • getPagesList

      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
    • 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
    • setPages

      public Document.Builder setPages(int index, Document.Page value)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • setPages

      public Document.Builder setPages(int index, Document.Page.Builder builderForValue)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addPages

      public Document.Builder addPages(Document.Page value)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addPages

      public Document.Builder addPages(int index, Document.Page value)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addPages

      public Document.Builder addPages(Document.Page.Builder builderForValue)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addPages

      public Document.Builder addPages(int index, Document.Page.Builder builderForValue)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addAllPages

      public Document.Builder addAllPages(Iterable<? extends Document.Page> values)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • clearPages

      public Document.Builder clearPages()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • removePages

      public Document.Builder removePages(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • getPagesBuilder

      public Document.Page.Builder getPagesBuilder(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • 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
    • 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
    • addPagesBuilder

      public Document.Page.Builder addPagesBuilder()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • addPagesBuilder

      public Document.Page.Builder addPagesBuilder(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • getPagesBuilderList

      public List<Document.Page.Builder> getPagesBuilderList()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
       
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;
    • 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
    • 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
    • setEntities

      public Document.Builder setEntities(int index, Document.Entity value)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • setEntities

      public Document.Builder setEntities(int index, Document.Entity.Builder builderForValue)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addEntities

      public Document.Builder addEntities(Document.Entity value)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addEntities

      public Document.Builder addEntities(int index, Document.Entity value)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addEntities

      public Document.Builder addEntities(Document.Entity.Builder builderForValue)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addEntities

      public Document.Builder addEntities(int index, Document.Entity.Builder builderForValue)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addAllEntities

      public Document.Builder addAllEntities(Iterable<? extends Document.Entity> values)
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • clearEntities

      public Document.Builder clearEntities()
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • removeEntities

      public Document.Builder removeEntities(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;
    • getEntitiesBuilder

      public Document.Entity.Builder getEntitiesBuilder(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;
    • 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
    • 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
    • addEntitiesBuilder

      public Document.Entity.Builder addEntitiesBuilder()
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • addEntitiesBuilder

      public Document.Entity.Builder addEntitiesBuilder(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;
    • getEntitiesBuilderList

      public List<Document.Entity.Builder> getEntitiesBuilderList()
       A list of entities detected on
       [Document.text][google.cloud.documentai.v1.Document.text]. For document
       shards, entities in this list may cross shard boundaries.
       
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
    • getEntityRelationsList

      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
    • 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
    • setEntityRelations

      public Document.Builder setEntityRelations(int index, Document.EntityRelation value)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • setEntityRelations

      public Document.Builder setEntityRelations(int index, Document.EntityRelation.Builder builderForValue)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addEntityRelations

      public Document.Builder addEntityRelations(Document.EntityRelation value)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addEntityRelations

      public Document.Builder addEntityRelations(int index, Document.EntityRelation value)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addEntityRelations

      public Document.Builder addEntityRelations(Document.EntityRelation.Builder builderForValue)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addEntityRelations

      public Document.Builder addEntityRelations(int index, Document.EntityRelation.Builder builderForValue)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addAllEntityRelations

      public Document.Builder addAllEntityRelations(Iterable<? extends Document.EntityRelation> values)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • clearEntityRelations

      public Document.Builder clearEntityRelations()
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • removeEntityRelations

      public Document.Builder removeEntityRelations(int index)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • getEntityRelationsBuilder

      public Document.EntityRelation.Builder getEntityRelationsBuilder(int index)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • 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
    • 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
    • addEntityRelationsBuilder

      public Document.EntityRelation.Builder addEntityRelationsBuilder()
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • addEntityRelationsBuilder

      public Document.EntityRelation.Builder addEntityRelationsBuilder(int index)
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • getEntityRelationsBuilderList

      public List<Document.EntityRelation.Builder> getEntityRelationsBuilderList()
       Placeholder.  Relationship among
       [Document.entities][google.cloud.documentai.v1.Document.entities].
       
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
    • 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
    • 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
    • setTextChanges

      public Document.Builder setTextChanges(int index, Document.TextChange value)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • setTextChanges

      public Document.Builder setTextChanges(int index, Document.TextChange.Builder builderForValue)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addTextChanges

      public Document.Builder addTextChanges(Document.TextChange value)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addTextChanges

      public Document.Builder addTextChanges(int index, Document.TextChange value)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addTextChanges

      public Document.Builder addTextChanges(Document.TextChange.Builder builderForValue)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addTextChanges

      public Document.Builder addTextChanges(int index, Document.TextChange.Builder builderForValue)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addAllTextChanges

      public Document.Builder addAllTextChanges(Iterable<? extends Document.TextChange> values)
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • clearTextChanges

      public Document.Builder clearTextChanges()
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • removeTextChanges

      public Document.Builder removeTextChanges(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;
    • getTextChangesBuilder

      public Document.TextChange.Builder getTextChangesBuilder(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;
    • 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
    • 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
    • addTextChangesBuilder

      public Document.TextChange.Builder addTextChangesBuilder()
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • addTextChangesBuilder

      public Document.TextChange.Builder addTextChangesBuilder(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;
    • getTextChangesBuilderList

      public List<Document.TextChange.Builder> getTextChangesBuilderList()
       Placeholder.  A list of text corrections made to
       [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
       used for annotating corrections to OCR mistakes.  Text changes for a given
       revision may not overlap with each other.
       
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;
    • hasShardInfo

      public boolean hasShardInfo()
       Information about the sharding if this document is sharded part of a larger
       document. If the document is not sharded, this message is not specified.
       
      .google.cloud.documentai.v1.Document.ShardInfo shard_info = 9;
      Specified by:
      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.
    • setShardInfo

      public 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.v1.Document.ShardInfo shard_info = 9;
    • setShardInfo

      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.v1.Document.ShardInfo shard_info = 9;
    • mergeShardInfo

      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.v1.Document.ShardInfo shard_info = 9;
    • clearShardInfo

      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.v1.Document.ShardInfo shard_info = 9;
    • getShardInfoBuilder

      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.v1.Document.ShardInfo shard_info = 9;
    • 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.
    • setError

      public Document.Builder setError(Status value)
       Any error that occurred while processing this document.
       
      .google.rpc.Status error = 10;
    • setError

      public Document.Builder setError(Status.Builder builderForValue)
       Any error that occurred while processing this document.
       
      .google.rpc.Status error = 10;
    • mergeError

      public Document.Builder mergeError(Status value)
       Any error that occurred while processing this document.
       
      .google.rpc.Status error = 10;
    • clearError

      public Document.Builder clearError()
       Any error that occurred while processing this document.
       
      .google.rpc.Status error = 10;
    • getErrorBuilder

      public Status.Builder getErrorBuilder()
       Any error that occurred while processing this document.
       
      .google.rpc.Status error = 10;
    • 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
    • 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
    • setRevisions

      public Document.Builder setRevisions(int index, Document.Revision value)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • setRevisions

      public Document.Builder setRevisions(int index, Document.Revision.Builder builderForValue)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addRevisions

      public Document.Builder addRevisions(Document.Revision value)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addRevisions

      public Document.Builder addRevisions(int index, Document.Revision value)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addRevisions

      public Document.Builder addRevisions(Document.Revision.Builder builderForValue)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addRevisions

      public Document.Builder addRevisions(int index, Document.Revision.Builder builderForValue)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addAllRevisions

      public Document.Builder addAllRevisions(Iterable<? extends Document.Revision> values)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • clearRevisions

      public Document.Builder clearRevisions()
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • removeRevisions

      public Document.Builder removeRevisions(int index)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • getRevisionsBuilder

      public Document.Revision.Builder getRevisionsBuilder(int index)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • 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
    • 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
    • addRevisionsBuilder

      public Document.Revision.Builder addRevisionsBuilder()
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • addRevisionsBuilder

      public Document.Revision.Builder addRevisionsBuilder(int index)
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • getRevisionsBuilderList

      public List<Document.Revision.Builder> getRevisionsBuilderList()
       Placeholder. Revision history of this document.
       
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
    • hasDocumentLayout

      public boolean hasDocumentLayout()
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Specified by:
      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.
    • setDocumentLayout

      public Document.Builder setDocumentLayout(Document.DocumentLayout value)
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
    • setDocumentLayout

      public Document.Builder setDocumentLayout(Document.DocumentLayout.Builder builderForValue)
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
    • mergeDocumentLayout

      public Document.Builder mergeDocumentLayout(Document.DocumentLayout value)
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
    • clearDocumentLayout

      public Document.Builder clearDocumentLayout()
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
    • getDocumentLayoutBuilder

      public Document.DocumentLayout.Builder getDocumentLayoutBuilder()
       Parsed layout of the document.
       
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
    • 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.
    • setChunkedDocument

      public Document.Builder setChunkedDocument(Document.ChunkedDocument value)
       Document chunked based on chunking config.
       
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
    • setChunkedDocument

      public Document.Builder setChunkedDocument(Document.ChunkedDocument.Builder builderForValue)
       Document chunked based on chunking config.
       
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
    • mergeChunkedDocument

      public Document.Builder mergeChunkedDocument(Document.ChunkedDocument value)
       Document chunked based on chunking config.
       
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
    • clearChunkedDocument

      public Document.Builder clearChunkedDocument()
       Document chunked based on chunking config.
       
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
    • getChunkedDocumentBuilder

      public Document.ChunkedDocument.Builder getChunkedDocumentBuilder()
       Document chunked based on chunking config.
       
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
    • 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
    • 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
    • setBlobAssets

      public Document.Builder setBlobAssets(int index, Document.BlobAsset value)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • setBlobAssets

      public Document.Builder setBlobAssets(int index, Document.BlobAsset.Builder builderForValue)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addBlobAssets

      public Document.Builder addBlobAssets(Document.BlobAsset value)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addBlobAssets

      public Document.Builder addBlobAssets(int index, Document.BlobAsset value)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addBlobAssets

      public Document.Builder addBlobAssets(Document.BlobAsset.Builder builderForValue)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addBlobAssets

      public Document.Builder addBlobAssets(int index, Document.BlobAsset.Builder builderForValue)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addAllBlobAssets

      public Document.Builder addAllBlobAssets(Iterable<? extends Document.BlobAsset> values)
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • clearBlobAssets

      public Document.Builder clearBlobAssets()
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • removeBlobAssets

      public Document.Builder removeBlobAssets(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];
    • getBlobAssetsBuilder

      public Document.BlobAsset.Builder getBlobAssetsBuilder(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];
    • 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
    • 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
    • addBlobAssetsBuilder

      public Document.BlobAsset.Builder addBlobAssetsBuilder()
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • addBlobAssetsBuilder

      public Document.BlobAsset.Builder addBlobAssetsBuilder(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];
    • getBlobAssetsBuilderList

      public List<Document.BlobAsset.Builder> getBlobAssetsBuilderList()
       Optional. The blob assets in this document. This is used to store the
       content of the inline blobs in this document, for example, image bytes,
       such that it can be referenced by other fields in the document via asset
       id.
       
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];
    • hasEntityValidationOutput

      public boolean hasEntityValidationOutput()
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
      Specified by:
      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.
    • setEntityValidationOutput

      public Document.Builder setEntityValidationOutput(Document.EntityValidationOutput value)
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
    • setEntityValidationOutput

      public Document.Builder setEntityValidationOutput(Document.EntityValidationOutput.Builder builderForValue)
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
    • mergeEntityValidationOutput

      public Document.Builder mergeEntityValidationOutput(Document.EntityValidationOutput value)
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
    • clearEntityValidationOutput

      public Document.Builder clearEntityValidationOutput()
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
    • getEntityValidationOutputBuilder

      public Document.EntityValidationOutput.Builder getEntityValidationOutputBuilder()
       The entity validation output for the document. This is the validation
       output for `document.entities` field.
       
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
    • getEntityValidationOutputOrBuilder

      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
    • 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
    • setEntitiesRevisions

      public Document.Builder setEntitiesRevisions(int index, Document.EntitiesRevision value)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • setEntitiesRevisions

      public Document.Builder setEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addEntitiesRevisions

      public Document.Builder addEntitiesRevisions(Document.EntitiesRevision value)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addEntitiesRevisions

      public Document.Builder addEntitiesRevisions(int index, Document.EntitiesRevision value)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addEntitiesRevisions

      public Document.Builder addEntitiesRevisions(Document.EntitiesRevision.Builder builderForValue)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addEntitiesRevisions

      public Document.Builder addEntitiesRevisions(int index, Document.EntitiesRevision.Builder builderForValue)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addAllEntitiesRevisions

      public Document.Builder addAllEntitiesRevisions(Iterable<? extends Document.EntitiesRevision> values)
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • clearEntitiesRevisions

      public Document.Builder clearEntitiesRevisions()
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • removeEntitiesRevisions

      public Document.Builder removeEntitiesRevisions(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;
    • getEntitiesRevisionsBuilder

      public Document.EntitiesRevision.Builder getEntitiesRevisionsBuilder(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;
    • 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
    • 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
    • addEntitiesRevisionsBuilder

      public Document.EntitiesRevision.Builder addEntitiesRevisionsBuilder()
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • addEntitiesRevisionsBuilder

      public Document.EntitiesRevision.Builder addEntitiesRevisionsBuilder(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;
    • getEntitiesRevisionsBuilderList

      public List<Document.EntitiesRevision.Builder> getEntitiesRevisionsBuilderList()
       A list of entity revisions. The entity revisions are appended to the
       document in the processing order. This field can be used for comparing the
       entity extraction results at different stages of the processing.
       
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;
    • getEntitiesRevisionId

      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.
    • setEntitiesRevisionId

      public Document.Builder setEntitiesRevisionId(String value)
       The entity revision ID that `document.entities` field is based on.
       If this field is set and `entities_revisions` is not empty, the entities in
       `document.entities` field are the entities in the entity revision with this
       id and `document.entity_validation_output` field is the
       `entity_validation_output` field in this entity revision.
       
      string entities_revision_id = 23;
      Parameters:
      value - The entitiesRevisionId to set.
      Returns:
      This builder for chaining.
    • clearEntitiesRevisionId

      public Document.Builder clearEntitiesRevisionId()
       The entity revision ID that `document.entities` field is based on.
       If this field is set and `entities_revisions` is not empty, the entities in
       `document.entities` field are the entities in the entity revision with this
       id and `document.entity_validation_output` field is the
       `entity_validation_output` field in this entity revision.
       
      string entities_revision_id = 23;
      Returns:
      This builder for chaining.
    • setEntitiesRevisionIdBytes

      public Document.Builder setEntitiesRevisionIdBytes(com.google.protobuf.ByteString value)
       The entity revision ID that `document.entities` field is based on.
       If this field is set and `entities_revisions` is not empty, the entities in
       `document.entities` field are the entities in the entity revision with this
       id and `document.entity_validation_output` field is the
       `entity_validation_output` field in this entity revision.
       
      string entities_revision_id = 23;
      Parameters:
      value - The bytes for entitiesRevisionId to set.
      Returns:
      This builder for chaining.