Class Document.Page.Builder (2.47.0)

Version 2.47.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static final class Document.Page.Builder extends GeneratedMessageV3.Builder<Document.Page.Builder> implements Document.PageOrBuilder

A page in a Document.

Protobuf type google.cloud.documentai.v1.Document.Page

Inheritance

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

Implements

Document.PageOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllBlocks(Iterable<? extends Document.Page.Block> values)

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

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

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

Returns
Type	Description
Document.Page.Builder

addAllDetectedBarcodes(Iterable<? extends Document.Page.DetectedBarcode> values)

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

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

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

Returns
Type	Description
Document.Page.Builder

addAllDetectedLanguages(Iterable<? extends Document.Page.DetectedLanguage> values)

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

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

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

Returns
Type	Description
Document.Page.Builder

addAllFormFields(Iterable<? extends Document.Page.FormField> values)

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

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

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

Returns
Type	Description
Document.Page.Builder

addAllLines(Iterable<? extends Document.Page.Line> values)

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

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

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

Returns
Type	Description
Document.Page.Builder

addAllParagraphs(Iterable<? extends Document.Page.Paragraph> values)

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

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

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

Returns
Type	Description
Document.Page.Builder

addAllSymbols(Iterable<? extends Document.Page.Symbol> values)

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

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

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

Returns
Type	Description
Document.Page.Builder

addAllTables(Iterable<? extends Document.Page.Table> values)

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

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

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

Returns
Type	Description
Document.Page.Builder

addAllTokens(Iterable<? extends Document.Page.Token> values)

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

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

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

Returns
Type	Description
Document.Page.Builder

addAllTransforms(Iterable<? extends Document.Page.Matrix> values)

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

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

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

Returns
Type	Description
Document.Page.Builder

addAllVisualElements(Iterable<? extends Document.Page.VisualElement> values)

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

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

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

Returns
Type	Description
Document.Page.Builder

addBlocks(Document.Page.Block value)

public Document.Page.Builder addBlocks(Document.Page.Block value)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
value	Document.Page.Block

Returns
Type	Description
Document.Page.Builder

addBlocks(Document.Page.Block.Builder builderForValue)

public Document.Page.Builder addBlocks(Document.Page.Block.Builder builderForValue)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
builderForValue	Document.Page.Block.Builder

Returns
Type	Description
Document.Page.Builder

addBlocks(int index, Document.Page.Block value)

public Document.Page.Builder addBlocks(int index, Document.Page.Block value)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameters
Name	Description
index	int
value	Document.Page.Block

Returns
Type	Description
Document.Page.Builder

addBlocks(int index, Document.Page.Block.Builder builderForValue)

public Document.Page.Builder addBlocks(int index, Document.Page.Block.Builder builderForValue)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Block.Builder

Returns
Type	Description
Document.Page.Builder

addBlocksBuilder()

public Document.Page.Block.Builder addBlocksBuilder()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Returns
Type	Description
Document.Page.Block.Builder

addBlocksBuilder(int index)

public Document.Page.Block.Builder addBlocksBuilder(int index)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Block.Builder

addDetectedBarcodes(Document.Page.DetectedBarcode value)

public Document.Page.Builder addDetectedBarcodes(Document.Page.DetectedBarcode value)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
value	Document.Page.DetectedBarcode

Returns
Type	Description
Document.Page.Builder

addDetectedBarcodes(Document.Page.DetectedBarcode.Builder builderForValue)

public Document.Page.Builder addDetectedBarcodes(Document.Page.DetectedBarcode.Builder builderForValue)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
builderForValue	Document.Page.DetectedBarcode.Builder

Returns
Type	Description
Document.Page.Builder

addDetectedBarcodes(int index, Document.Page.DetectedBarcode value)

public Document.Page.Builder addDetectedBarcodes(int index, Document.Page.DetectedBarcode value)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameters
Name	Description
index	int
value	Document.Page.DetectedBarcode

Returns
Type	Description
Document.Page.Builder

addDetectedBarcodes(int index, Document.Page.DetectedBarcode.Builder builderForValue)

public Document.Page.Builder addDetectedBarcodes(int index, Document.Page.DetectedBarcode.Builder builderForValue)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameters
Name	Description
index	int
builderForValue	Document.Page.DetectedBarcode.Builder

Returns
Type	Description
Document.Page.Builder

addDetectedBarcodesBuilder()

public Document.Page.DetectedBarcode.Builder addDetectedBarcodesBuilder()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
Document.Page.DetectedBarcode.Builder

addDetectedBarcodesBuilder(int index)

public Document.Page.DetectedBarcode.Builder addDetectedBarcodesBuilder(int index)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedBarcode.Builder

addDetectedLanguages(Document.Page.DetectedLanguage value)

public Document.Page.Builder addDetectedLanguages(Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
value	Document.Page.DetectedLanguage

Returns
Type	Description
Document.Page.Builder

addDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.Builder addDetectedLanguages(Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
builderForValue	Document.Page.DetectedLanguage.Builder

Returns
Type	Description
Document.Page.Builder

addDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.Builder addDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameters
Name	Description
index	int
value	Document.Page.DetectedLanguage

Returns
Type	Description
Document.Page.Builder

addDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.Builder addDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameters
Name	Description
index	int
builderForValue	Document.Page.DetectedLanguage.Builder

Returns
Type	Description
Document.Page.Builder

addDetectedLanguagesBuilder()

public Document.Page.DetectedLanguage.Builder addDetectedLanguagesBuilder()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Returns
Type	Description
Document.Page.DetectedLanguage.Builder

addDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder addDetectedLanguagesBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage.Builder

addFormFields(Document.Page.FormField value)

public Document.Page.Builder addFormFields(Document.Page.FormField value)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
value	Document.Page.FormField

Returns
Type	Description
Document.Page.Builder

addFormFields(Document.Page.FormField.Builder builderForValue)

public Document.Page.Builder addFormFields(Document.Page.FormField.Builder builderForValue)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
builderForValue	Document.Page.FormField.Builder

Returns
Type	Description
Document.Page.Builder

addFormFields(int index, Document.Page.FormField value)

public Document.Page.Builder addFormFields(int index, Document.Page.FormField value)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameters
Name	Description
index	int
value	Document.Page.FormField

Returns
Type	Description
Document.Page.Builder

addFormFields(int index, Document.Page.FormField.Builder builderForValue)

public Document.Page.Builder addFormFields(int index, Document.Page.FormField.Builder builderForValue)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameters
Name	Description
index	int
builderForValue	Document.Page.FormField.Builder

Returns
Type	Description
Document.Page.Builder

addFormFieldsBuilder()

public Document.Page.FormField.Builder addFormFieldsBuilder()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Returns
Type	Description
Document.Page.FormField.Builder

addFormFieldsBuilder(int index)

public Document.Page.FormField.Builder addFormFieldsBuilder(int index)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.FormField.Builder

addLines(Document.Page.Line value)

public Document.Page.Builder addLines(Document.Page.Line value)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
value	Document.Page.Line

Returns
Type	Description
Document.Page.Builder

addLines(Document.Page.Line.Builder builderForValue)

public Document.Page.Builder addLines(Document.Page.Line.Builder builderForValue)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
builderForValue	Document.Page.Line.Builder

Returns
Type	Description
Document.Page.Builder

addLines(int index, Document.Page.Line value)

public Document.Page.Builder addLines(int index, Document.Page.Line value)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameters
Name	Description
index	int
value	Document.Page.Line

Returns
Type	Description
Document.Page.Builder

addLines(int index, Document.Page.Line.Builder builderForValue)

public Document.Page.Builder addLines(int index, Document.Page.Line.Builder builderForValue)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Line.Builder

Returns
Type	Description
Document.Page.Builder

addLinesBuilder()

public Document.Page.Line.Builder addLinesBuilder()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Returns
Type	Description
Document.Page.Line.Builder

addLinesBuilder(int index)

public Document.Page.Line.Builder addLinesBuilder(int index)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Line.Builder

addParagraphs(Document.Page.Paragraph value)

public Document.Page.Builder addParagraphs(Document.Page.Paragraph value)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
value	Document.Page.Paragraph

Returns
Type	Description
Document.Page.Builder

addParagraphs(Document.Page.Paragraph.Builder builderForValue)

public Document.Page.Builder addParagraphs(Document.Page.Paragraph.Builder builderForValue)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
builderForValue	Document.Page.Paragraph.Builder

Returns
Type	Description
Document.Page.Builder

addParagraphs(int index, Document.Page.Paragraph value)

public Document.Page.Builder addParagraphs(int index, Document.Page.Paragraph value)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameters
Name	Description
index	int
value	Document.Page.Paragraph

Returns
Type	Description
Document.Page.Builder

addParagraphs(int index, Document.Page.Paragraph.Builder builderForValue)

public Document.Page.Builder addParagraphs(int index, Document.Page.Paragraph.Builder builderForValue)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Paragraph.Builder

Returns
Type	Description
Document.Page.Builder

addParagraphsBuilder()

public Document.Page.Paragraph.Builder addParagraphsBuilder()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Returns
Type	Description
Document.Page.Paragraph.Builder

addParagraphsBuilder(int index)

public Document.Page.Paragraph.Builder addParagraphsBuilder(int index)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Paragraph.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSymbols(Document.Page.Symbol value)

public Document.Page.Builder addSymbols(Document.Page.Symbol value)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
value	Document.Page.Symbol

Returns
Type	Description
Document.Page.Builder

addSymbols(Document.Page.Symbol.Builder builderForValue)

public Document.Page.Builder addSymbols(Document.Page.Symbol.Builder builderForValue)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
builderForValue	Document.Page.Symbol.Builder

Returns
Type	Description
Document.Page.Builder

addSymbols(int index, Document.Page.Symbol value)

public Document.Page.Builder addSymbols(int index, Document.Page.Symbol value)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameters
Name	Description
index	int
value	Document.Page.Symbol

Returns
Type	Description
Document.Page.Builder

addSymbols(int index, Document.Page.Symbol.Builder builderForValue)

public Document.Page.Builder addSymbols(int index, Document.Page.Symbol.Builder builderForValue)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Symbol.Builder

Returns
Type	Description
Document.Page.Builder

addSymbolsBuilder()

public Document.Page.Symbol.Builder addSymbolsBuilder()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Returns
Type	Description
Document.Page.Symbol.Builder

addSymbolsBuilder(int index)

public Document.Page.Symbol.Builder addSymbolsBuilder(int index)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Symbol.Builder

addTables(Document.Page.Table value)

public Document.Page.Builder addTables(Document.Page.Table value)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
value	Document.Page.Table

Returns
Type	Description
Document.Page.Builder

addTables(Document.Page.Table.Builder builderForValue)

public Document.Page.Builder addTables(Document.Page.Table.Builder builderForValue)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
builderForValue	Document.Page.Table.Builder

Returns
Type	Description
Document.Page.Builder

addTables(int index, Document.Page.Table value)

public Document.Page.Builder addTables(int index, Document.Page.Table value)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameters
Name	Description
index	int
value	Document.Page.Table

Returns
Type	Description
Document.Page.Builder

addTables(int index, Document.Page.Table.Builder builderForValue)

public Document.Page.Builder addTables(int index, Document.Page.Table.Builder builderForValue)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Table.Builder

Returns
Type	Description
Document.Page.Builder

addTablesBuilder()

public Document.Page.Table.Builder addTablesBuilder()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Returns
Type	Description
Document.Page.Table.Builder

addTablesBuilder(int index)

public Document.Page.Table.Builder addTablesBuilder(int index)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Table.Builder

addTokens(Document.Page.Token value)

public Document.Page.Builder addTokens(Document.Page.Token value)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
value	Document.Page.Token

Returns
Type	Description
Document.Page.Builder

addTokens(Document.Page.Token.Builder builderForValue)

public Document.Page.Builder addTokens(Document.Page.Token.Builder builderForValue)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
builderForValue	Document.Page.Token.Builder

Returns
Type	Description
Document.Page.Builder

addTokens(int index, Document.Page.Token value)

public Document.Page.Builder addTokens(int index, Document.Page.Token value)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameters
Name	Description
index	int
value	Document.Page.Token

Returns
Type	Description
Document.Page.Builder

addTokens(int index, Document.Page.Token.Builder builderForValue)

public Document.Page.Builder addTokens(int index, Document.Page.Token.Builder builderForValue)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Token.Builder

Returns
Type	Description
Document.Page.Builder

addTokensBuilder()

public Document.Page.Token.Builder addTokensBuilder()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Returns
Type	Description
Document.Page.Token.Builder

addTokensBuilder(int index)

public Document.Page.Token.Builder addTokensBuilder(int index)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Token.Builder

addTransforms(Document.Page.Matrix value)

public Document.Page.Builder addTransforms(Document.Page.Matrix value)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
value	Document.Page.Matrix

Returns
Type	Description
Document.Page.Builder

addTransforms(Document.Page.Matrix.Builder builderForValue)

public Document.Page.Builder addTransforms(Document.Page.Matrix.Builder builderForValue)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
builderForValue	Document.Page.Matrix.Builder

Returns
Type	Description
Document.Page.Builder

addTransforms(int index, Document.Page.Matrix value)

public Document.Page.Builder addTransforms(int index, Document.Page.Matrix value)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameters
Name	Description
index	int
value	Document.Page.Matrix

Returns
Type	Description
Document.Page.Builder

addTransforms(int index, Document.Page.Matrix.Builder builderForValue)

public Document.Page.Builder addTransforms(int index, Document.Page.Matrix.Builder builderForValue)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Matrix.Builder

Returns
Type	Description
Document.Page.Builder

addTransformsBuilder()

public Document.Page.Matrix.Builder addTransformsBuilder()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Returns
Type	Description
Document.Page.Matrix.Builder

addTransformsBuilder(int index)

public Document.Page.Matrix.Builder addTransformsBuilder(int index)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Matrix.Builder

addVisualElements(Document.Page.VisualElement value)

public Document.Page.Builder addVisualElements(Document.Page.VisualElement value)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
value	Document.Page.VisualElement

Returns
Type	Description
Document.Page.Builder

addVisualElements(Document.Page.VisualElement.Builder builderForValue)

public Document.Page.Builder addVisualElements(Document.Page.VisualElement.Builder builderForValue)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
builderForValue	Document.Page.VisualElement.Builder

Returns
Type	Description
Document.Page.Builder

addVisualElements(int index, Document.Page.VisualElement value)

public Document.Page.Builder addVisualElements(int index, Document.Page.VisualElement value)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameters
Name	Description
index	int
value	Document.Page.VisualElement

Returns
Type	Description
Document.Page.Builder

addVisualElements(int index, Document.Page.VisualElement.Builder builderForValue)

public Document.Page.Builder addVisualElements(int index, Document.Page.VisualElement.Builder builderForValue)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameters
Name	Description
index	int
builderForValue	Document.Page.VisualElement.Builder

Returns
Type	Description
Document.Page.Builder

addVisualElementsBuilder()

public Document.Page.VisualElement.Builder addVisualElementsBuilder()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Returns
Type	Description
Document.Page.VisualElement.Builder

addVisualElementsBuilder(int index)

public Document.Page.VisualElement.Builder addVisualElementsBuilder(int index)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.VisualElement.Builder

build()

public Document.Page build()

Returns
Type	Description
Document.Page

buildPartial()

public Document.Page buildPartial()

Returns
Type	Description
Document.Page

clear()

public Document.Page.Builder clear()

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBlocks()

public Document.Page.Builder clearBlocks()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Returns
Type	Description
Document.Page.Builder

clearDetectedBarcodes()

public Document.Page.Builder clearDetectedBarcodes()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
Document.Page.Builder

clearDetectedLanguages()

public Document.Page.Builder clearDetectedLanguages()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Returns
Type	Description
Document.Page.Builder

clearDimension()

public Document.Page.Builder clearDimension()

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Returns
Type	Description
Document.Page.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Page.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFormFields()

public Document.Page.Builder clearFormFields()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Returns
Type	Description
Document.Page.Builder

clearImage()

public Document.Page.Builder clearImage()

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.Builder

clearImageQualityScores()

public Document.Page.Builder clearImageQualityScores()

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Returns
Type	Description
Document.Page.Builder

clearLayout()

public Document.Page.Builder clearLayout()

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Returns
Type	Description
Document.Page.Builder

clearLines()

public Document.Page.Builder clearLines()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Returns
Type	Description
Document.Page.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageNumber()

public Document.Page.Builder clearPageNumber()

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

int32 page_number = 1;

Returns
Type	Description
Document.Page.Builder	This builder for chaining.

clearParagraphs()

public Document.Page.Builder clearParagraphs()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Returns
Type	Description
Document.Page.Builder

clearProvenance() (deprecated)

public Document.Page.Builder clearProvenance()

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Returns
Type	Description
Document.Page.Builder

clearSymbols()

public Document.Page.Builder clearSymbols()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Returns
Type	Description
Document.Page.Builder

clearTables()

public Document.Page.Builder clearTables()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Returns
Type	Description
Document.Page.Builder

clearTokens()

public Document.Page.Builder clearTokens()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Returns
Type	Description
Document.Page.Builder

clearTransforms()

public Document.Page.Builder clearTransforms()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Returns
Type	Description
Document.Page.Builder

clearVisualElements()

public Document.Page.Builder clearVisualElements()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Returns
Type	Description
Document.Page.Builder

clone()

public Document.Page.Builder clone()

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBlocks(int index)

public Document.Page.Block getBlocks(int index)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Block

getBlocksBuilder(int index)

public Document.Page.Block.Builder getBlocksBuilder(int index)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Block.Builder

getBlocksBuilderList()

public List<Document.Page.Block.Builder> getBlocksBuilderList()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Returns
Type	Description
List<Builder>

getBlocksCount()

public int getBlocksCount()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Returns
Type	Description
int

getBlocksList()

public List<Document.Page.Block> getBlocksList()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Returns
Type	Description
List<Block>

getBlocksOrBuilder(int index)

public Document.Page.BlockOrBuilder getBlocksOrBuilder(int index)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.BlockOrBuilder

getBlocksOrBuilderList()

public List<? extends Document.Page.BlockOrBuilder> getBlocksOrBuilderList()

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

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

getDefaultInstanceForType()

public Document.Page getDefaultInstanceForType()

Returns
Type	Description
Document.Page

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDetectedBarcodes(int index)

public Document.Page.DetectedBarcode getDetectedBarcodes(int index)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedBarcode

getDetectedBarcodesBuilder(int index)

public Document.Page.DetectedBarcode.Builder getDetectedBarcodesBuilder(int index)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedBarcode.Builder

getDetectedBarcodesBuilderList()

public List<Document.Page.DetectedBarcode.Builder> getDetectedBarcodesBuilderList()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
List<Builder>

getDetectedBarcodesCount()

public int getDetectedBarcodesCount()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
int

getDetectedBarcodesList()

public List<Document.Page.DetectedBarcode> getDetectedBarcodesList()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
List<DetectedBarcode>

getDetectedBarcodesOrBuilder(int index)

public Document.Page.DetectedBarcodeOrBuilder getDetectedBarcodesOrBuilder(int index)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedBarcodeOrBuilder

getDetectedBarcodesOrBuilderList()

public List<? extends Document.Page.DetectedBarcodeOrBuilder> getDetectedBarcodesOrBuilderList()

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

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

getDetectedLanguages(int index)

public Document.Page.DetectedLanguage getDetectedLanguages(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage

getDetectedLanguagesBuilder(int index)

public Document.Page.DetectedLanguage.Builder getDetectedLanguagesBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage.Builder

getDetectedLanguagesBuilderList()

public List<Document.Page.DetectedLanguage.Builder> getDetectedLanguagesBuilderList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Returns
Type	Description
List<Builder>

getDetectedLanguagesCount()

public int getDetectedLanguagesCount()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Returns
Type	Description
int

getDetectedLanguagesList()

public List<Document.Page.DetectedLanguage> getDetectedLanguagesList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Returns
Type	Description
List<DetectedLanguage>

getDetectedLanguagesOrBuilder(int index)

public Document.Page.DetectedLanguageOrBuilder getDetectedLanguagesOrBuilder(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguageOrBuilder

getDetectedLanguagesOrBuilderList()

public List<? extends Document.Page.DetectedLanguageOrBuilder> getDetectedLanguagesOrBuilderList()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

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

getDimension()

public Document.Page.Dimension getDimension()

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Returns
Type	Description
Document.Page.Dimension	The dimension.

getDimensionBuilder()

public Document.Page.Dimension.Builder getDimensionBuilder()

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Returns
Type	Description
Document.Page.Dimension.Builder

getDimensionOrBuilder()

public Document.Page.DimensionOrBuilder getDimensionOrBuilder()

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Returns
Type	Description
Document.Page.DimensionOrBuilder

getFormFields(int index)

public Document.Page.FormField getFormFields(int index)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.FormField

getFormFieldsBuilder(int index)

public Document.Page.FormField.Builder getFormFieldsBuilder(int index)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.FormField.Builder

getFormFieldsBuilderList()

public List<Document.Page.FormField.Builder> getFormFieldsBuilderList()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Returns
Type	Description
List<Builder>

getFormFieldsCount()

public int getFormFieldsCount()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Returns
Type	Description
int

getFormFieldsList()

public List<Document.Page.FormField> getFormFieldsList()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Returns
Type	Description
List<FormField>

getFormFieldsOrBuilder(int index)

public Document.Page.FormFieldOrBuilder getFormFieldsOrBuilder(int index)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.FormFieldOrBuilder

getFormFieldsOrBuilderList()

public List<? extends Document.Page.FormFieldOrBuilder> getFormFieldsOrBuilderList()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

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

getImage()

public Document.Page.Image getImage()

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.Image	The image.

getImageBuilder()

public Document.Page.Image.Builder getImageBuilder()

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.Image.Builder

getImageOrBuilder()

public Document.Page.ImageOrBuilder getImageOrBuilder()

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.ImageOrBuilder

getImageQualityScores()

public Document.Page.ImageQualityScores getImageQualityScores()

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Returns
Type	Description
Document.Page.ImageQualityScores	The imageQualityScores.

getImageQualityScoresBuilder()

public Document.Page.ImageQualityScores.Builder getImageQualityScoresBuilder()

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Returns
Type	Description
Document.Page.ImageQualityScores.Builder

getImageQualityScoresOrBuilder()

public Document.Page.ImageQualityScoresOrBuilder getImageQualityScoresOrBuilder()

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Returns
Type	Description
Document.Page.ImageQualityScoresOrBuilder

getLayout()

public Document.Page.Layout getLayout()

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Returns
Type	Description
Document.Page.Layout	The layout.

getLayoutBuilder()

public Document.Page.Layout.Builder getLayoutBuilder()

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Returns
Type	Description
Document.Page.Layout.Builder

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Returns
Type	Description
Document.Page.LayoutOrBuilder

getLines(int index)

public Document.Page.Line getLines(int index)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Line

getLinesBuilder(int index)

public Document.Page.Line.Builder getLinesBuilder(int index)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Line.Builder

getLinesBuilderList()

public List<Document.Page.Line.Builder> getLinesBuilderList()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Returns
Type	Description
List<Builder>

getLinesCount()

public int getLinesCount()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Returns
Type	Description
int

getLinesList()

public List<Document.Page.Line> getLinesList()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Returns
Type	Description
List<Line>

getLinesOrBuilder(int index)

public Document.Page.LineOrBuilder getLinesOrBuilder(int index)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.LineOrBuilder

getLinesOrBuilderList()

public List<? extends Document.Page.LineOrBuilder> getLinesOrBuilderList()

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

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

getPageNumber()

public int getPageNumber()

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

int32 page_number = 1;

Returns
Type	Description
int	The pageNumber.

getParagraphs(int index)

public Document.Page.Paragraph getParagraphs(int index)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Paragraph

getParagraphsBuilder(int index)

public Document.Page.Paragraph.Builder getParagraphsBuilder(int index)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Paragraph.Builder

getParagraphsBuilderList()

public List<Document.Page.Paragraph.Builder> getParagraphsBuilderList()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Returns
Type	Description
List<Builder>

getParagraphsCount()

public int getParagraphsCount()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Returns
Type	Description
int

getParagraphsList()

public List<Document.Page.Paragraph> getParagraphsList()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Returns
Type	Description
List<Paragraph>

getParagraphsOrBuilder(int index)

public Document.Page.ParagraphOrBuilder getParagraphsOrBuilder(int index)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.ParagraphOrBuilder

getParagraphsOrBuilderList()

public List<? extends Document.Page.ParagraphOrBuilder> getParagraphsOrBuilderList()

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

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

getProvenance() (deprecated)

public Document.Provenance getProvenance()

Deprecated. google.cloud.documentai.v1.Document.Page.provenance is deprecated. See google/cloud/documentai/v1/document.proto;l=522

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Returns
Type	Description
Document.Provenance	The provenance.

getProvenanceBuilder() (deprecated)

public Document.Provenance.Builder getProvenanceBuilder()

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Returns
Type	Description
Document.Provenance.Builder

getProvenanceOrBuilder() (deprecated)

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Returns
Type	Description
Document.ProvenanceOrBuilder

getSymbols(int index)

public Document.Page.Symbol getSymbols(int index)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Symbol

getSymbolsBuilder(int index)

public Document.Page.Symbol.Builder getSymbolsBuilder(int index)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Symbol.Builder

getSymbolsBuilderList()

public List<Document.Page.Symbol.Builder> getSymbolsBuilderList()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Returns
Type	Description
List<Builder>

getSymbolsCount()

public int getSymbolsCount()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Returns
Type	Description
int

getSymbolsList()

public List<Document.Page.Symbol> getSymbolsList()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Returns
Type	Description
List<Symbol>

getSymbolsOrBuilder(int index)

public Document.Page.SymbolOrBuilder getSymbolsOrBuilder(int index)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.SymbolOrBuilder

getSymbolsOrBuilderList()

public List<? extends Document.Page.SymbolOrBuilder> getSymbolsOrBuilderList()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

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

getTables(int index)

public Document.Page.Table getTables(int index)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Table

getTablesBuilder(int index)

public Document.Page.Table.Builder getTablesBuilder(int index)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Table.Builder

getTablesBuilderList()

public List<Document.Page.Table.Builder> getTablesBuilderList()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Returns
Type	Description
List<Builder>

getTablesCount()

public int getTablesCount()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Returns
Type	Description
int

getTablesList()

public List<Document.Page.Table> getTablesList()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Returns
Type	Description
List<Table>

getTablesOrBuilder(int index)

public Document.Page.TableOrBuilder getTablesOrBuilder(int index)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.TableOrBuilder

getTablesOrBuilderList()

public List<? extends Document.Page.TableOrBuilder> getTablesOrBuilderList()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

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

getTokens(int index)

public Document.Page.Token getTokens(int index)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Token

getTokensBuilder(int index)

public Document.Page.Token.Builder getTokensBuilder(int index)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Token.Builder

getTokensBuilderList()

public List<Document.Page.Token.Builder> getTokensBuilderList()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Returns
Type	Description
List<Builder>

getTokensCount()

public int getTokensCount()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Returns
Type	Description
int

getTokensList()

public List<Document.Page.Token> getTokensList()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Returns
Type	Description
List<Token>

getTokensOrBuilder(int index)

public Document.Page.TokenOrBuilder getTokensOrBuilder(int index)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.TokenOrBuilder

getTokensOrBuilderList()

public List<? extends Document.Page.TokenOrBuilder> getTokensOrBuilderList()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

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

getTransforms(int index)

public Document.Page.Matrix getTransforms(int index)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Matrix

getTransformsBuilder(int index)

public Document.Page.Matrix.Builder getTransformsBuilder(int index)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Matrix.Builder

getTransformsBuilderList()

public List<Document.Page.Matrix.Builder> getTransformsBuilderList()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Returns
Type	Description
List<Builder>

getTransformsCount()

public int getTransformsCount()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Returns
Type	Description
int

getTransformsList()

public List<Document.Page.Matrix> getTransformsList()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Returns
Type	Description
List<Matrix>

getTransformsOrBuilder(int index)

public Document.Page.MatrixOrBuilder getTransformsOrBuilder(int index)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.MatrixOrBuilder

getTransformsOrBuilderList()

public List<? extends Document.Page.MatrixOrBuilder> getTransformsOrBuilderList()

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

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

getVisualElements(int index)

public Document.Page.VisualElement getVisualElements(int index)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.VisualElement

getVisualElementsBuilder(int index)

public Document.Page.VisualElement.Builder getVisualElementsBuilder(int index)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.VisualElement.Builder

getVisualElementsBuilderList()

public List<Document.Page.VisualElement.Builder> getVisualElementsBuilderList()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Returns
Type	Description
List<Builder>

getVisualElementsCount()

public int getVisualElementsCount()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Returns
Type	Description
int

getVisualElementsList()

public List<Document.Page.VisualElement> getVisualElementsList()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Returns
Type	Description
List<VisualElement>

getVisualElementsOrBuilder(int index)

public Document.Page.VisualElementOrBuilder getVisualElementsOrBuilder(int index)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.VisualElementOrBuilder

getVisualElementsOrBuilderList()

public List<? extends Document.Page.VisualElementOrBuilder> getVisualElementsOrBuilderList()

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

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

hasDimension()

public boolean hasDimension()

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Returns
Type	Description
boolean	Whether the dimension field is set.

hasImage()

public boolean hasImage()

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Returns
Type	Description
boolean	Whether the image field is set.

hasImageQualityScores()

public boolean hasImageQualityScores()

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Returns
Type	Description
boolean	Whether the imageQualityScores field is set.

hasLayout()

public boolean hasLayout()

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Returns
Type	Description
boolean	Whether the layout field is set.

hasProvenance() (deprecated)

public boolean hasProvenance()

Deprecated. google.cloud.documentai.v1.Document.Page.provenance is deprecated. See google/cloud/documentai/v1/document.proto;l=522

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Returns
Type	Description
boolean	Whether the provenance field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDimension(Document.Page.Dimension value)

public Document.Page.Builder mergeDimension(Document.Page.Dimension value)

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Parameter
Name	Description
value	Document.Page.Dimension

Returns
Type	Description
Document.Page.Builder

mergeFrom(Document.Page other)

public Document.Page.Builder mergeFrom(Document.Page other)

Parameter
Name	Description
other	Document.Page

Returns
Type	Description
Document.Page.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Document.Page.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Document.Page.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeImage(Document.Page.Image value)

public Document.Page.Builder mergeImage(Document.Page.Image value)

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Parameter
Name	Description
value	Document.Page.Image

Returns
Type	Description
Document.Page.Builder

mergeImageQualityScores(Document.Page.ImageQualityScores value)

public Document.Page.Builder mergeImageQualityScores(Document.Page.ImageQualityScores value)

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Parameter
Name	Description
value	Document.Page.ImageQualityScores

Returns
Type	Description
Document.Page.Builder

mergeLayout(Document.Page.Layout value)

public Document.Page.Builder mergeLayout(Document.Page.Layout value)

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Parameter
Name	Description
value	Document.Page.Layout

Returns
Type	Description
Document.Page.Builder

mergeProvenance(Document.Provenance value) (deprecated)

public Document.Page.Builder mergeProvenance(Document.Provenance value)

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Parameter
Name	Description
value	Document.Provenance

Returns
Type	Description
Document.Page.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeBlocks(int index)

public Document.Page.Builder removeBlocks(int index)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeDetectedBarcodes(int index)

public Document.Page.Builder removeDetectedBarcodes(int index)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeDetectedLanguages(int index)

public Document.Page.Builder removeDetectedLanguages(int index)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeFormFields(int index)

public Document.Page.Builder removeFormFields(int index)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeLines(int index)

public Document.Page.Builder removeLines(int index)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeParagraphs(int index)

public Document.Page.Builder removeParagraphs(int index)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeSymbols(int index)

public Document.Page.Builder removeSymbols(int index)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeTables(int index)

public Document.Page.Builder removeTables(int index)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeTokens(int index)

public Document.Page.Builder removeTokens(int index)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeTransforms(int index)

public Document.Page.Builder removeTransforms(int index)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

removeVisualElements(int index)

public Document.Page.Builder removeVisualElements(int index)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Builder

setBlocks(int index, Document.Page.Block value)

public Document.Page.Builder setBlocks(int index, Document.Page.Block value)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameters
Name	Description
index	int
value	Document.Page.Block

Returns
Type	Description
Document.Page.Builder

setBlocks(int index, Document.Page.Block.Builder builderForValue)

public Document.Page.Builder setBlocks(int index, Document.Page.Block.Builder builderForValue)

A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Block.Builder

Returns
Type	Description
Document.Page.Builder

setDetectedBarcodes(int index, Document.Page.DetectedBarcode value)

public Document.Page.Builder setDetectedBarcodes(int index, Document.Page.DetectedBarcode value)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameters
Name	Description
index	int
value	Document.Page.DetectedBarcode

Returns
Type	Description
Document.Page.Builder

setDetectedBarcodes(int index, Document.Page.DetectedBarcode.Builder builderForValue)

public Document.Page.Builder setDetectedBarcodes(int index, Document.Page.DetectedBarcode.Builder builderForValue)

A list of detected barcodes.

repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;

Parameters
Name	Description
index	int
builderForValue	Document.Page.DetectedBarcode.Builder

Returns
Type	Description
Document.Page.Builder

setDetectedLanguages(int index, Document.Page.DetectedLanguage value)

public Document.Page.Builder setDetectedLanguages(int index, Document.Page.DetectedLanguage value)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameters
Name	Description
index	int
value	Document.Page.DetectedLanguage

Returns
Type	Description
Document.Page.Builder

setDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

public Document.Page.Builder setDetectedLanguages(int index, Document.Page.DetectedLanguage.Builder builderForValue)

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;

Parameters
Name	Description
index	int
builderForValue	Document.Page.DetectedLanguage.Builder

Returns
Type	Description
Document.Page.Builder

setDimension(Document.Page.Dimension value)

public Document.Page.Builder setDimension(Document.Page.Dimension value)

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Parameter
Name	Description
value	Document.Page.Dimension

Returns
Type	Description
Document.Page.Builder

setDimension(Document.Page.Dimension.Builder builderForValue)

public Document.Page.Builder setDimension(Document.Page.Dimension.Builder builderForValue)

Physical dimension of the page.

.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;

Parameter
Name	Description
builderForValue	Document.Page.Dimension.Builder

Returns
Type	Description
Document.Page.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFormFields(int index, Document.Page.FormField value)

public Document.Page.Builder setFormFields(int index, Document.Page.FormField value)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameters
Name	Description
index	int
value	Document.Page.FormField

Returns
Type	Description
Document.Page.Builder

setFormFields(int index, Document.Page.FormField.Builder builderForValue)

public Document.Page.Builder setFormFields(int index, Document.Page.FormField.Builder builderForValue)

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;

Parameters
Name	Description
index	int
builderForValue	Document.Page.FormField.Builder

Returns
Type	Description
Document.Page.Builder

setImage(Document.Page.Image value)

public Document.Page.Builder setImage(Document.Page.Image value)

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Parameter
Name	Description
value	Document.Page.Image

Returns
Type	Description
Document.Page.Builder

setImage(Document.Page.Image.Builder builderForValue)

public Document.Page.Builder setImage(Document.Page.Image.Builder builderForValue)

Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.

.google.cloud.documentai.v1.Document.Page.Image image = 13;

Parameter
Name	Description
builderForValue	Document.Page.Image.Builder

Returns
Type	Description
Document.Page.Builder

setImageQualityScores(Document.Page.ImageQualityScores value)

public Document.Page.Builder setImageQualityScores(Document.Page.ImageQualityScores value)

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Parameter
Name	Description
value	Document.Page.ImageQualityScores

Returns
Type	Description
Document.Page.Builder

setImageQualityScores(Document.Page.ImageQualityScores.Builder builderForValue)

public Document.Page.Builder setImageQualityScores(Document.Page.ImageQualityScores.Builder builderForValue)

Image quality scores.

.google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;

Parameter
Name	Description
builderForValue	Document.Page.ImageQualityScores.Builder

Returns
Type	Description
Document.Page.Builder

setLayout(Document.Page.Layout value)

public Document.Page.Builder setLayout(Document.Page.Layout value)

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Parameter
Name	Description
value	Document.Page.Layout

Returns
Type	Description
Document.Page.Builder

setLayout(Document.Page.Layout.Builder builderForValue)

public Document.Page.Builder setLayout(Document.Page.Layout.Builder builderForValue)

Layout for the page.

.google.cloud.documentai.v1.Document.Page.Layout layout = 3;

Parameter
Name	Description
builderForValue	Document.Page.Layout.Builder

Returns
Type	Description
Document.Page.Builder

setLines(int index, Document.Page.Line value)

public Document.Page.Builder setLines(int index, Document.Page.Line value)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameters
Name	Description
index	int
value	Document.Page.Line

Returns
Type	Description
Document.Page.Builder

setLines(int index, Document.Page.Line.Builder builderForValue)

public Document.Page.Builder setLines(int index, Document.Page.Line.Builder builderForValue)

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Line.Builder

Returns
Type	Description
Document.Page.Builder

setPageNumber(int value)

public Document.Page.Builder setPageNumber(int value)

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

int32 page_number = 1;

Parameter
Name	Description
value	int The pageNumber to set.

Returns
Type	Description
Document.Page.Builder	This builder for chaining.

setParagraphs(int index, Document.Page.Paragraph value)

public Document.Page.Builder setParagraphs(int index, Document.Page.Paragraph value)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameters
Name	Description
index	int
value	Document.Page.Paragraph

Returns
Type	Description
Document.Page.Builder

setParagraphs(int index, Document.Page.Paragraph.Builder builderForValue)

public Document.Page.Builder setParagraphs(int index, Document.Page.Paragraph.Builder builderForValue)

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Paragraph.Builder

Returns
Type	Description
Document.Page.Builder

setProvenance(Document.Provenance value) (deprecated)

public Document.Page.Builder setProvenance(Document.Provenance value)

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Parameter
Name	Description
value	Document.Provenance

Returns
Type	Description
Document.Page.Builder

setProvenance(Document.Provenance.Builder builderForValue) (deprecated)

public Document.Page.Builder setProvenance(Document.Provenance.Builder builderForValue)

The history of this page.

.google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];

Parameter
Name	Description
builderForValue	Document.Provenance.Builder

Returns
Type	Description
Document.Page.Builder

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

public Document.Page.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSymbols(int index, Document.Page.Symbol value)

public Document.Page.Builder setSymbols(int index, Document.Page.Symbol value)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameters
Name	Description
index	int
value	Document.Page.Symbol

Returns
Type	Description
Document.Page.Builder

setSymbols(int index, Document.Page.Symbol.Builder builderForValue)

public Document.Page.Builder setSymbols(int index, Document.Page.Symbol.Builder builderForValue)

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Symbol.Builder

Returns
Type	Description
Document.Page.Builder

setTables(int index, Document.Page.Table value)

public Document.Page.Builder setTables(int index, Document.Page.Table value)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameters
Name	Description
index	int
value	Document.Page.Table

Returns
Type	Description
Document.Page.Builder

setTables(int index, Document.Page.Table.Builder builderForValue)

public Document.Page.Builder setTables(int index, Document.Page.Table.Builder builderForValue)

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Table.Builder

Returns
Type	Description
Document.Page.Builder

setTokens(int index, Document.Page.Token value)

public Document.Page.Builder setTokens(int index, Document.Page.Token value)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameters
Name	Description
index	int
value	Document.Page.Token

Returns
Type	Description
Document.Page.Builder

setTokens(int index, Document.Page.Token.Builder builderForValue)

public Document.Page.Builder setTokens(int index, Document.Page.Token.Builder builderForValue)

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Token.Builder

Returns
Type	Description
Document.Page.Builder

setTransforms(int index, Document.Page.Matrix value)

public Document.Page.Builder setTransforms(int index, Document.Page.Matrix value)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameters
Name	Description
index	int
value	Document.Page.Matrix

Returns
Type	Description
Document.Page.Builder

setTransforms(int index, Document.Page.Matrix.Builder builderForValue)

public Document.Page.Builder setTransforms(int index, Document.Page.Matrix.Builder builderForValue)

Transformation matrices that were applied to the original document image to produce Page.image.

repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;

Parameters
Name	Description
index	int
builderForValue	Document.Page.Matrix.Builder

Returns
Type	Description
Document.Page.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVisualElements(int index, Document.Page.VisualElement value)

public Document.Page.Builder setVisualElements(int index, Document.Page.VisualElement value)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameters
Name	Description
index	int
value	Document.Page.VisualElement

Returns
Type	Description
Document.Page.Builder

setVisualElements(int index, Document.Page.VisualElement.Builder builderForValue)

public Document.Page.Builder setVisualElements(int index, Document.Page.VisualElement.Builder builderForValue)

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;

Parameters
Name	Description
index	int
builderForValue	Document.Page.VisualElement.Builder

Returns
Type	Description
Document.Page.Builder