Class Document.Page (2.52.0)

Version 2.52.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 extends GeneratedMessageV3 implements Document.PageOrBuilder

A page in a Document.

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

Inheritance

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

Implements

Document.PageOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BLOCKS_FIELD_NUMBER

public static final int BLOCKS_FIELD_NUMBER

Field Value
Type	Description
int

DETECTED_BARCODES_FIELD_NUMBER

public static final int DETECTED_BARCODES_FIELD_NUMBER

Field Value
Type	Description
int

DETECTED_LANGUAGES_FIELD_NUMBER

public static final int DETECTED_LANGUAGES_FIELD_NUMBER

Field Value
Type	Description
int

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER

Field Value
Type	Description
int

FORM_FIELDS_FIELD_NUMBER

public static final int FORM_FIELDS_FIELD_NUMBER

Field Value
Type	Description
int

IMAGE_FIELD_NUMBER

public static final int IMAGE_FIELD_NUMBER

Field Value
Type	Description
int

IMAGE_QUALITY_SCORES_FIELD_NUMBER

public static final int IMAGE_QUALITY_SCORES_FIELD_NUMBER

Field Value
Type	Description
int

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER

Field Value
Type	Description
int

LINES_FIELD_NUMBER

public static final int LINES_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_NUMBER_FIELD_NUMBER

public static final int PAGE_NUMBER_FIELD_NUMBER

Field Value
Type	Description
int

PARAGRAPHS_FIELD_NUMBER

public static final int PARAGRAPHS_FIELD_NUMBER

Field Value
Type	Description
int

PROVENANCE_FIELD_NUMBER

public static final int PROVENANCE_FIELD_NUMBER

Field Value
Type	Description
int

SYMBOLS_FIELD_NUMBER

public static final int SYMBOLS_FIELD_NUMBER

Field Value
Type	Description
int

TABLES_FIELD_NUMBER

public static final int TABLES_FIELD_NUMBER

Field Value
Type	Description
int

TOKENS_FIELD_NUMBER

public static final int TOKENS_FIELD_NUMBER

Field Value
Type	Description
int

TRANSFORMS_FIELD_NUMBER

public static final int TRANSFORMS_FIELD_NUMBER

Field Value
Type	Description
int

VISUAL_ELEMENTS_FIELD_NUMBER

public static final int VISUAL_ELEMENTS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Document.Page getDefaultInstance()

Returns
Type	Description
Document.Page

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Document.Page.Builder newBuilder()

Returns
Type	Description
Document.Page.Builder

newBuilder(Document.Page prototype)

public static Document.Page.Builder newBuilder(Document.Page prototype)

Parameter
Name	Description
prototype	Document.Page

Returns
Type	Description
Document.Page.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document.Page parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Document.Page parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document.Page parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Page

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Page> parser()

Returns
Type	Description
Parser<Page>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.v1beta3.Document.Page.Block blocks = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Block

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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Block blocks = 5;

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

getDefaultInstanceForType()

public Document.Page getDefaultInstanceForType()

Returns
Type	Description
Document.Page

getDetectedBarcodes(int index)

public Document.Page.DetectedBarcode getDetectedBarcodes(int index)

A list of detected barcodes.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedBarcode

getDetectedBarcodesCount()

public int getDetectedBarcodesCount()

A list of detected barcodes.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.DetectedBarcode detected_barcodes = 15;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.DetectedLanguage detected_languages = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.DetectedLanguage

getDetectedLanguagesCount()

public int getDetectedLanguagesCount()

A list of detected languages together with confidence.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.DetectedLanguage detected_languages = 4;

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

getDimension()

public Document.Page.Dimension getDimension()

Physical dimension of the page.

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

Returns
Type	Description
Document.Page.Dimension	The dimension.

getDimensionOrBuilder()

public Document.Page.DimensionOrBuilder getDimensionOrBuilder()

Physical dimension of the page.

.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.FormField form_fields = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.FormField

getFormFieldsCount()

public int getFormFieldsCount()

A list of visually detected form fields on the page.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.FormField form_fields = 11;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.Image	The image.

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.v1beta3.Document.Page.Image image = 13;

Returns
Type	Description
Document.Page.ImageOrBuilder

getImageQualityScores()

public Document.Page.ImageQualityScores getImageQualityScores()

Image quality scores.

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

Returns
Type	Description
Document.Page.ImageQualityScores	The imageQualityScores.

getImageQualityScoresOrBuilder()

public Document.Page.ImageQualityScoresOrBuilder getImageQualityScoresOrBuilder()

Image quality scores.

.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Layout layout = 3;

Returns
Type	Description
Document.Page.Layout	The layout.

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for the page.

.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Line lines = 7;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Line

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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Line lines = 7;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Paragraph paragraphs = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Paragraph

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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Paragraph paragraphs = 6;

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

getParserForType()

public Parser<Document.Page> getParserForType()

Returns
Type	Description
Parser<Page>

Overrides

GeneratedMessageV3.getParserForType()

getProvenance() (deprecated)

public Document.Provenance getProvenance()

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

The history of this page.

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

Returns
Type	Description
Document.Provenance	The provenance.

getProvenanceOrBuilder() (deprecated)

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

The history of this page.

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

Returns
Type	Description
Document.ProvenanceOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSymbols(int index)

public Document.Page.Symbol getSymbols(int index)

A list of visually detected symbols on the page.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Symbol

getSymbolsCount()

public int getSymbolsCount()

A list of visually detected symbols on the page.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Symbol symbols = 12;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Table tables = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Table

getTablesCount()

public int getTablesCount()

A list of visually detected tables on the page.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Table tables = 10;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Token tokens = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Token

getTokensCount()

public int getTokensCount()

A list of visually detected tokens on the page.

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Token tokens = 8;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.Matrix transforms = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.Matrix

getTransformsCount()

public int getTransformsCount()

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

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Matrix transforms = 14;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.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.v1beta3.Document.Page.VisualElement visual_elements = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Page.VisualElement

getVisualElementsCount()

public int getVisualElementsCount()

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

repeated .google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.VisualElement visual_elements = 9;

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

hasDimension()

public boolean hasDimension()

Physical dimension of the page.

.google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.Page.Layout layout = 3;

Returns
Type	Description
boolean	Whether the layout field is set.

hasProvenance() (deprecated)

public boolean hasProvenance()

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

The history of this page.

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

Returns
Type	Description
boolean	Whether the provenance field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Document.Page.Builder newBuilderForType()

Returns
Type	Description
Document.Page.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Document.Page.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Document.Page.Builder toBuilder()

Returns
Type	Description
Document.Page.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException