Class Document.Builder (2.59.0) 

public static final class Document.Builder extends GeneratedMessageV3.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Builder

Implements

DocumentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllEntities(Iterable<? extends Document.Entity> values)

public Document.Builder addAllEntities(Iterable<? extends Document.Entity> values)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Entity>
Returns
Type Description
Document.Builder

addAllEntityRelations(Iterable<? extends Document.EntityRelation> values)

public Document.Builder addAllEntityRelations(Iterable<? extends Document.EntityRelation> values)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.EntityRelation>
Returns
Type Description
Document.Builder

addAllPages(Iterable<? extends Document.Page> values)

public Document.Builder addAllPages(Iterable<? extends Document.Page> values)

Visual page layout for the Document.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Page>
Returns
Type Description
Document.Builder

addAllRevisions(Iterable<? extends Document.Revision> values)

public Document.Builder addAllRevisions(Iterable<? extends Document.Revision> values)

Placeholder. Revision history of this document.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Revision>
Returns
Type Description
Document.Builder

addAllTextChanges(Iterable<? extends Document.TextChange> values)

public Document.Builder addAllTextChanges(Iterable<? extends Document.TextChange> values)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.TextChange>
Returns
Type Description
Document.Builder

addAllTextStyles(Iterable<? extends Document.Style> values) (deprecated)

public Document.Builder addAllTextStyles(Iterable<? extends Document.Style> values)

Styles for the Document.text.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Style>
Returns
Type Description
Document.Builder

addEntities(Document.Entity value)

public Document.Builder addEntities(Document.Entity value)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
value Document.Entity
Returns
Type Description
Document.Builder

addEntities(Document.Entity.Builder builderForValue)

public Document.Builder addEntities(Document.Entity.Builder builderForValue)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
builderForValue Document.Entity.Builder
Returns
Type Description
Document.Builder

addEntities(int index, Document.Entity value)

public Document.Builder addEntities(int index, Document.Entity value)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameters
Name Description
index int
value Document.Entity
Returns
Type Description
Document.Builder

addEntities(int index, Document.Entity.Builder builderForValue)

public Document.Builder addEntities(int index, Document.Entity.Builder builderForValue)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameters
Name Description
index int
builderForValue Document.Entity.Builder
Returns
Type Description
Document.Builder

addEntitiesBuilder()

public Document.Entity.Builder addEntitiesBuilder()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
Document.Entity.Builder

addEntitiesBuilder(int index)

public Document.Entity.Builder addEntitiesBuilder(int index)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Entity.Builder

addEntityRelations(Document.EntityRelation value)

public Document.Builder addEntityRelations(Document.EntityRelation value)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
value Document.EntityRelation
Returns
Type Description
Document.Builder

addEntityRelations(Document.EntityRelation.Builder builderForValue)

public Document.Builder addEntityRelations(Document.EntityRelation.Builder builderForValue)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
builderForValue Document.EntityRelation.Builder
Returns
Type Description
Document.Builder

addEntityRelations(int index, Document.EntityRelation value)

public Document.Builder addEntityRelations(int index, Document.EntityRelation value)

Placeholder. Relationship among Document.entities.

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

Parameters
Name Description
index int
value Document.EntityRelation
Returns
Type Description
Document.Builder

addEntityRelations(int index, Document.EntityRelation.Builder builderForValue)

public Document.Builder addEntityRelations(int index, Document.EntityRelation.Builder builderForValue)

Placeholder. Relationship among Document.entities.

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

Parameters
Name Description
index int
builderForValue Document.EntityRelation.Builder
Returns
Type Description
Document.Builder

addEntityRelationsBuilder()

public Document.EntityRelation.Builder addEntityRelationsBuilder()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
Document.EntityRelation.Builder

addEntityRelationsBuilder(int index)

public Document.EntityRelation.Builder addEntityRelationsBuilder(int index)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
index int
Returns
Type Description
Document.EntityRelation.Builder

addPages(Document.Page value)

public Document.Builder addPages(Document.Page value)

Visual page layout for the Document.

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

Parameter
Name Description
value Document.Page
Returns
Type Description
Document.Builder

addPages(Document.Page.Builder builderForValue)

public Document.Builder addPages(Document.Page.Builder builderForValue)

Visual page layout for the Document.

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

Parameter
Name Description
builderForValue Document.Page.Builder
Returns
Type Description
Document.Builder

addPages(int index, Document.Page value)

public Document.Builder addPages(int index, Document.Page value)

Visual page layout for the Document.

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

Parameters
Name Description
index int
value Document.Page
Returns
Type Description
Document.Builder

addPages(int index, Document.Page.Builder builderForValue)

public Document.Builder addPages(int index, Document.Page.Builder builderForValue)

Visual page layout for the Document.

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

Parameters
Name Description
index int
builderForValue Document.Page.Builder
Returns
Type Description
Document.Builder

addPagesBuilder()

public Document.Page.Builder addPagesBuilder()

Visual page layout for the Document.

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

Returns
Type Description
Document.Page.Builder

addPagesBuilder(int index)

public Document.Page.Builder addPagesBuilder(int index)

Visual page layout for the Document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Page.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Builder
Overrides

addRevisions(Document.Revision value)

public Document.Builder addRevisions(Document.Revision value)

Placeholder. Revision history of this document.

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

Parameter
Name Description
value Document.Revision
Returns
Type Description
Document.Builder

addRevisions(Document.Revision.Builder builderForValue)

public Document.Builder addRevisions(Document.Revision.Builder builderForValue)

Placeholder. Revision history of this document.

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

Parameter
Name Description
builderForValue Document.Revision.Builder
Returns
Type Description
Document.Builder

addRevisions(int index, Document.Revision value)

public Document.Builder addRevisions(int index, Document.Revision value)

Placeholder. Revision history of this document.

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

Parameters
Name Description
index int
value Document.Revision
Returns
Type Description
Document.Builder

addRevisions(int index, Document.Revision.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Document.Revision.Builder
Returns
Type Description
Document.Builder

addRevisionsBuilder()

public Document.Revision.Builder addRevisionsBuilder()

Placeholder. Revision history of this document.

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

Returns
Type Description
Document.Revision.Builder

addRevisionsBuilder(int index)

public Document.Revision.Builder addRevisionsBuilder(int index)

Placeholder. Revision history of this document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Revision.Builder

addTextChanges(Document.TextChange value)

public Document.Builder addTextChanges(Document.TextChange value)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
value Document.TextChange
Returns
Type Description
Document.Builder

addTextChanges(Document.TextChange.Builder builderForValue)

public Document.Builder addTextChanges(Document.TextChange.Builder builderForValue)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
builderForValue Document.TextChange.Builder
Returns
Type Description
Document.Builder

addTextChanges(int index, Document.TextChange value)

public Document.Builder addTextChanges(int index, Document.TextChange value)

Placeholder. A list of text corrections made to 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;

Parameters
Name Description
index int
value Document.TextChange
Returns
Type Description
Document.Builder

addTextChanges(int index, Document.TextChange.Builder builderForValue)

public Document.Builder addTextChanges(int index, Document.TextChange.Builder builderForValue)

Placeholder. A list of text corrections made to 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;

Parameters
Name Description
index int
builderForValue Document.TextChange.Builder
Returns
Type Description
Document.Builder

addTextChangesBuilder()

public Document.TextChange.Builder addTextChangesBuilder()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
Document.TextChange.Builder

addTextChangesBuilder(int index)

public Document.TextChange.Builder addTextChangesBuilder(int index)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
index int
Returns
Type Description
Document.TextChange.Builder

addTextStyles(Document.Style value) (deprecated)

public Document.Builder addTextStyles(Document.Style value)

Styles for the Document.text.

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

Parameter
Name Description
value Document.Style
Returns
Type Description
Document.Builder

addTextStyles(Document.Style.Builder builderForValue) (deprecated)

public Document.Builder addTextStyles(Document.Style.Builder builderForValue)

Styles for the Document.text.

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

Parameter
Name Description
builderForValue Document.Style.Builder
Returns
Type Description
Document.Builder

addTextStyles(int index, Document.Style value) (deprecated)

public Document.Builder addTextStyles(int index, Document.Style value)

Styles for the Document.text.

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

Parameters
Name Description
index int
value Document.Style
Returns
Type Description
Document.Builder

addTextStyles(int index, Document.Style.Builder builderForValue) (deprecated)

public Document.Builder addTextStyles(int index, Document.Style.Builder builderForValue)

Styles for the Document.text.

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

Parameters
Name Description
index int
builderForValue Document.Style.Builder
Returns
Type Description
Document.Builder

addTextStylesBuilder() (deprecated)

public Document.Style.Builder addTextStylesBuilder()

Styles for the Document.text.

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

Returns
Type Description
Document.Style.Builder

addTextStylesBuilder(int index) (deprecated)

public Document.Style.Builder addTextStylesBuilder(int index)

Styles for the Document.text.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Style.Builder

build()

public Document build()
Returns
Type Description
Document

buildPartial()

public Document buildPartial()
Returns
Type Description
Document

clear()

public Document.Builder clear()
Returns
Type Description
Document.Builder
Overrides

clearChunkedDocument()

public Document.Builder clearChunkedDocument()

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Returns
Type Description
Document.Builder

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
Type Description
Document.Builder

This builder for chaining.

clearDocumentLayout()

public Document.Builder clearDocumentLayout()

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Returns
Type Description
Document.Builder

clearEntities()

public Document.Builder clearEntities()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
Document.Builder

clearEntityRelations()

public Document.Builder clearEntityRelations()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
Document.Builder

clearError()

public Document.Builder clearError()

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Returns
Type Description
Document.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Builder
Overrides

clearMimeType()

public Document.Builder clearMimeType()

An IANA published media type (MIME type).

string mime_type = 3;

Returns
Type Description
Document.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Builder
Overrides

clearPages()

public Document.Builder clearPages()

Visual page layout for the Document.

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

Returns
Type Description
Document.Builder

clearRevisions()

public Document.Builder clearRevisions()

Placeholder. Revision history of this document.

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

Returns
Type Description
Document.Builder

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;

Returns
Type Description
Document.Builder

clearSource()

public Document.Builder clearSource()
Returns
Type Description
Document.Builder

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
Type Description
Document.Builder

This builder for chaining.

clearTextChanges()

public Document.Builder clearTextChanges()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
Document.Builder

clearTextStyles() (deprecated)

public Document.Builder clearTextStyles()

Styles for the Document.text.

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

Returns
Type Description
Document.Builder

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.

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

Returns
Type Description
Document.Builder

This builder for chaining.

clone()

public Document.Builder clone()
Returns
Type Description
Document.Builder
Overrides

getChunkedDocument()

public Document.ChunkedDocument getChunkedDocument()

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Returns
Type Description
Document.ChunkedDocument

The chunkedDocument.

getChunkedDocumentBuilder()

public Document.ChunkedDocument.Builder getChunkedDocumentBuilder()

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Returns
Type Description
Document.ChunkedDocument.Builder

getChunkedDocumentOrBuilder()

public Document.ChunkedDocumentOrBuilder getChunkedDocumentOrBuilder()

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Returns
Type Description
Document.ChunkedDocumentOrBuilder

getContent()

public ByteString getContent()

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

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

Returns
Type Description
ByteString

The content.

getDefaultInstanceForType()

public Document getDefaultInstanceForType()
Returns
Type Description
Document

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentLayout()

public Document.DocumentLayout getDocumentLayout()

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Returns
Type Description
Document.DocumentLayout

The documentLayout.

getDocumentLayoutBuilder()

public Document.DocumentLayout.Builder getDocumentLayoutBuilder()

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Returns
Type Description
Document.DocumentLayout.Builder

getDocumentLayoutOrBuilder()

public Document.DocumentLayoutOrBuilder getDocumentLayoutOrBuilder()

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Returns
Type Description
Document.DocumentLayoutOrBuilder

getEntities(int index)

public Document.Entity getEntities(int index)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Entity

getEntitiesBuilder(int index)

public Document.Entity.Builder getEntitiesBuilder(int index)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Entity.Builder

getEntitiesBuilderList()

public List<Document.Entity.Builder> getEntitiesBuilderList()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
List<Builder>

getEntitiesCount()

public int getEntitiesCount()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
int

getEntitiesList()

public List<Document.Entity> getEntitiesList()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
List<Entity>

getEntitiesOrBuilder(int index)

public Document.EntityOrBuilder getEntitiesOrBuilder(int index)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
index int
Returns
Type Description
Document.EntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.EntityOrBuilder>

getEntityRelations(int index)

public Document.EntityRelation getEntityRelations(int index)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
index int
Returns
Type Description
Document.EntityRelation

getEntityRelationsBuilder(int index)

public Document.EntityRelation.Builder getEntityRelationsBuilder(int index)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
index int
Returns
Type Description
Document.EntityRelation.Builder

getEntityRelationsBuilderList()

public List<Document.EntityRelation.Builder> getEntityRelationsBuilderList()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
List<Builder>

getEntityRelationsCount()

public int getEntityRelationsCount()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
int

getEntityRelationsList()

public List<Document.EntityRelation> getEntityRelationsList()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
List<EntityRelation>

getEntityRelationsOrBuilder(int index)

public Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
index int
Returns
Type Description
Document.EntityRelationOrBuilder

getEntityRelationsOrBuilderList()

public List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()

Placeholder. Relationship among Document.entities.

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

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.EntityRelationOrBuilder>

getError()

public Status getError()

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorBuilder()

public Status.Builder getErrorBuilder()

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Returns
Type Description
com.google.rpc.Status.Builder

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getMimeType()

public String getMimeType()

An IANA published media type (MIME type).

string mime_type = 3;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

An IANA published media type (MIME type).

string mime_type = 3;

Returns
Type Description
ByteString

The bytes for mimeType.

getPages(int index)

public Document.Page getPages(int index)

Visual page layout for the Document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Page

getPagesBuilder(int index)

public Document.Page.Builder getPagesBuilder(int index)

Visual page layout for the Document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Page.Builder

getPagesBuilderList()

public List<Document.Page.Builder> getPagesBuilderList()

Visual page layout for the Document.

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

Returns
Type Description
List<Builder>

getPagesCount()

public int getPagesCount()

Visual page layout for the Document.

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

Returns
Type Description
int

getPagesList()

public List<Document.Page> getPagesList()

Visual page layout for the Document.

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

Returns
Type Description
List<Page>

getPagesOrBuilder(int index)

public Document.PageOrBuilder getPagesOrBuilder(int index)

Visual page layout for the Document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.PageOrBuilder

getPagesOrBuilderList()

public List<? extends Document.PageOrBuilder> getPagesOrBuilderList()

Visual page layout for the Document.

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

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.PageOrBuilder>

getRevisions(int index)

public Document.Revision getRevisions(int index)

Placeholder. Revision history of this document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Revision

getRevisionsBuilder(int index)

public Document.Revision.Builder getRevisionsBuilder(int index)

Placeholder. Revision history of this document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Revision.Builder

getRevisionsBuilderList()

public List<Document.Revision.Builder> getRevisionsBuilderList()

Placeholder. Revision history of this document.

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

Returns
Type Description
List<Builder>

getRevisionsCount()

public int getRevisionsCount()

Placeholder. Revision history of this document.

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

Returns
Type Description
int

getRevisionsList()

public List<Document.Revision> getRevisionsList()

Placeholder. Revision history of this document.

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

Returns
Type Description
List<Revision>

getRevisionsOrBuilder(int index)

public Document.RevisionOrBuilder getRevisionsOrBuilder(int index)

Placeholder. Revision history of this document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.RevisionOrBuilder

getRevisionsOrBuilderList()

public List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()

Placeholder. Revision history of this document.

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

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.RevisionOrBuilder>

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;

Returns
Type Description
Document.ShardInfo

The shardInfo.

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;

Returns
Type Description
Document.ShardInfo.Builder

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;

Returns
Type Description
Document.ShardInfoOrBuilder

getSourceCase()

public Document.SourceCase getSourceCase()
Returns
Type Description
Document.SourceCase

getText()

public String getText()

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

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

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

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

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

Returns
Type Description
ByteString

The bytes for text.

getTextChanges(int index)

public Document.TextChange getTextChanges(int index)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
index int
Returns
Type Description
Document.TextChange

getTextChangesBuilder(int index)

public Document.TextChange.Builder getTextChangesBuilder(int index)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
index int
Returns
Type Description
Document.TextChange.Builder

getTextChangesBuilderList()

public List<Document.TextChange.Builder> getTextChangesBuilderList()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
List<Builder>

getTextChangesCount()

public int getTextChangesCount()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
int

getTextChangesList()

public List<Document.TextChange> getTextChangesList()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
List<TextChange>

getTextChangesOrBuilder(int index)

public Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
index int
Returns
Type Description
Document.TextChangeOrBuilder

getTextChangesOrBuilderList()

public List<? extends Document.TextChangeOrBuilder> getTextChangesOrBuilderList()

Placeholder. A list of text corrections made to 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;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.TextChangeOrBuilder>

getTextStyles(int index) (deprecated)

public Document.Style getTextStyles(int index)

Styles for the Document.text.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Style

getTextStylesBuilder(int index) (deprecated)

public Document.Style.Builder getTextStylesBuilder(int index)

Styles for the Document.text.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Style.Builder

getTextStylesBuilderList() (deprecated)

public List<Document.Style.Builder> getTextStylesBuilderList()

Styles for the Document.text.

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

Returns
Type Description
List<Builder>

getTextStylesCount() (deprecated)

public int getTextStylesCount()

Styles for the Document.text.

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

Returns
Type Description
int

getTextStylesList() (deprecated)

public List<Document.Style> getTextStylesList()

Styles for the Document.text.

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

Returns
Type Description
List<Style>

getTextStylesOrBuilder(int index) (deprecated)

public Document.StyleOrBuilder getTextStylesOrBuilder(int index)

Styles for the Document.text.

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

Parameter
Name Description
index int
Returns
Type Description
Document.StyleOrBuilder

getTextStylesOrBuilderList() (deprecated)

public List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()

Styles for the Document.text.

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

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.StyleOrBuilder>

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.

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

Returns
Type Description
String

The uri.

getUriBytes()

public 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.

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

Returns
Type Description
ByteString

The bytes for uri.

hasChunkedDocument()

public boolean hasChunkedDocument()

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Returns
Type Description
boolean

Whether the chunkedDocument field is set.

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

Returns
Type Description
boolean

Whether the content field is set.

hasDocumentLayout()

public boolean hasDocumentLayout()

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Returns
Type Description
boolean

Whether the documentLayout field is set.

hasError()

public boolean hasError()

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Returns
Type Description
boolean

Whether the error field is set.

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;

Returns
Type Description
boolean

Whether the shardInfo field is set.

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.

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

Returns
Type Description
boolean

Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeChunkedDocument(Document.ChunkedDocument value)

public Document.Builder mergeChunkedDocument(Document.ChunkedDocument value)

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Parameter
Name Description
value Document.ChunkedDocument
Returns
Type Description
Document.Builder

mergeDocumentLayout(Document.DocumentLayout value)

public Document.Builder mergeDocumentLayout(Document.DocumentLayout value)

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Parameter
Name Description
value Document.DocumentLayout
Returns
Type Description
Document.Builder

mergeError(Status value)

public Document.Builder mergeError(Status value)

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Document.Builder

mergeFrom(Document other)

public Document.Builder mergeFrom(Document other)
Parameter
Name Description
other Document
Returns
Type Description
Document.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Builder
Overrides

mergeShardInfo(Document.ShardInfo value)

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;

Parameter
Name Description
value Document.ShardInfo
Returns
Type Description
Document.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Builder
Overrides

removeEntities(int index)

public Document.Builder removeEntities(int index)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

removeEntityRelations(int index)

public Document.Builder removeEntityRelations(int index)

Placeholder. Relationship among Document.entities.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

removePages(int index)

public Document.Builder removePages(int index)

Visual page layout for the Document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

removeRevisions(int index)

public Document.Builder removeRevisions(int index)

Placeholder. Revision history of this document.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

removeTextChanges(int index)

public Document.Builder removeTextChanges(int index)

Placeholder. A list of text corrections made to 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;

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

removeTextStyles(int index) (deprecated)

public Document.Builder removeTextStyles(int index)

Styles for the Document.text.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Builder

setChunkedDocument(Document.ChunkedDocument value)

public Document.Builder setChunkedDocument(Document.ChunkedDocument value)

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Parameter
Name Description
value Document.ChunkedDocument
Returns
Type Description
Document.Builder

setChunkedDocument(Document.ChunkedDocument.Builder builderForValue)

public Document.Builder setChunkedDocument(Document.ChunkedDocument.Builder builderForValue)

Document chunked based on chunking config.

.google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

Parameter
Name Description
builderForValue Document.ChunkedDocument.Builder
Returns
Type Description
Document.Builder

setContent(ByteString value)

public Document.Builder setContent(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];

Parameter
Name Description
value ByteString

The content to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setDocumentLayout(Document.DocumentLayout value)

public Document.Builder setDocumentLayout(Document.DocumentLayout value)

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Parameter
Name Description
value Document.DocumentLayout
Returns
Type Description
Document.Builder

setDocumentLayout(Document.DocumentLayout.Builder builderForValue)

public Document.Builder setDocumentLayout(Document.DocumentLayout.Builder builderForValue)

Parsed layout of the document.

.google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

Parameter
Name Description
builderForValue Document.DocumentLayout.Builder
Returns
Type Description
Document.Builder

setEntities(int index, Document.Entity value)

public Document.Builder setEntities(int index, Document.Entity value)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameters
Name Description
index int
value Document.Entity
Returns
Type Description
Document.Builder

setEntities(int index, Document.Entity.Builder builderForValue)

public Document.Builder setEntities(int index, Document.Entity.Builder builderForValue)

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

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

Parameters
Name Description
index int
builderForValue Document.Entity.Builder
Returns
Type Description
Document.Builder

setEntityRelations(int index, Document.EntityRelation value)

public Document.Builder setEntityRelations(int index, Document.EntityRelation value)

Placeholder. Relationship among Document.entities.

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

Parameters
Name Description
index int
value Document.EntityRelation
Returns
Type Description
Document.Builder

setEntityRelations(int index, Document.EntityRelation.Builder builderForValue)

public Document.Builder setEntityRelations(int index, Document.EntityRelation.Builder builderForValue)

Placeholder. Relationship among Document.entities.

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

Parameters
Name Description
index int
builderForValue Document.EntityRelation.Builder
Returns
Type Description
Document.Builder

setError(Status value)

public Document.Builder setError(Status value)

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Document.Builder

setError(Status.Builder builderForValue)

public Document.Builder setError(Status.Builder builderForValue)

Any error that occurred while processing this document.

.google.rpc.Status error = 10;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Document.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Builder
Overrides

setMimeType(String value)

public Document.Builder setMimeType(String value)

An IANA published media type (MIME type).

string mime_type = 3;

Parameter
Name Description
value String

The mimeType to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public Document.Builder setMimeTypeBytes(ByteString value)

An IANA published media type (MIME type).

string mime_type = 3;

Parameter
Name Description
value ByteString

The bytes for mimeType to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setPages(int index, Document.Page value)

public Document.Builder setPages(int index, Document.Page value)

Visual page layout for the Document.

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

Parameters
Name Description
index int
value Document.Page
Returns
Type Description
Document.Builder

setPages(int index, Document.Page.Builder builderForValue)

public Document.Builder setPages(int index, Document.Page.Builder builderForValue)

Visual page layout for the Document.

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

Parameters
Name Description
index int
builderForValue Document.Page.Builder
Returns
Type Description
Document.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Builder
Overrides

setRevisions(int index, Document.Revision value)

public Document.Builder setRevisions(int index, Document.Revision value)

Placeholder. Revision history of this document.

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

Parameters
Name Description
index int
value Document.Revision
Returns
Type Description
Document.Builder

setRevisions(int index, Document.Revision.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Document.Revision.Builder
Returns
Type Description
Document.Builder

setShardInfo(Document.ShardInfo value)

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;

Parameter
Name Description
value Document.ShardInfo
Returns
Type Description
Document.Builder

setShardInfo(Document.ShardInfo.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Document.ShardInfo.Builder
Returns
Type Description
Document.Builder

setText(String value)

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

Parameter
Name Description
value String

The text to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setTextBytes(ByteString value)

public Document.Builder setTextBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for text to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setTextChanges(int index, Document.TextChange value)

public Document.Builder setTextChanges(int index, Document.TextChange value)

Placeholder. A list of text corrections made to 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;

Parameters
Name Description
index int
value Document.TextChange
Returns
Type Description
Document.Builder

setTextChanges(int index, Document.TextChange.Builder builderForValue)

public Document.Builder setTextChanges(int index, Document.TextChange.Builder builderForValue)

Placeholder. A list of text corrections made to 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;

Parameters
Name Description
index int
builderForValue Document.TextChange.Builder
Returns
Type Description
Document.Builder

setTextStyles(int index, Document.Style value) (deprecated)

public Document.Builder setTextStyles(int index, Document.Style value)

Styles for the Document.text.

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

Parameters
Name Description
index int
value Document.Style
Returns
Type Description
Document.Builder

setTextStyles(int index, Document.Style.Builder builderForValue) (deprecated)

public Document.Builder setTextStyles(int index, Document.Style.Builder builderForValue)

Styles for the Document.text.

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

Parameters
Name Description
index int
builderForValue Document.Style.Builder
Returns
Type Description
Document.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Builder
Overrides

setUri(String value)

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.

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

Parameter
Name Description
value String

The uri to set.
Returns
Type Description
Document.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Document.Builder setUriBytes(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.

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

Parameter
Name Description
value ByteString

The bytes for uri to set.
Returns
Type Description
Document.Builder

This builder for chaining.