Class Document.Page (2.1.9) 

public static final class Document.Page extends GeneratedMessageV3 implements Document.PageOrBuilder

A page in a Document.

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

Inheritance

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

Fields

BLOCKS_FIELD_NUMBER

public static final int BLOCKS_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

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

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

VISUAL_ELEMENTS_FIELD_NUMBER

public static final int VISUAL_ELEMENTS_FIELD_NUMBER
Field Value
Type Description
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

getDefaultInstance()

public static Document.Page getDefaultInstance()
Returns
Type Description
Document.Page

getDefaultInstanceForType()

public Document.Page getDefaultInstanceForType()
Returns
Type Description
Document.Page

getDescriptor()

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

getDetectedLanguages(int index)

public Document.Page.DetectedLanguage getDetectedLanguages(int index)

A list of detected languages together with confidence.

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

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

getDimension()

public Document.Page.Dimension getDimension()

Physical dimension of the page.

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

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

getLayout()

public Document.Page.Layout getLayout()

Layout for the page.

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

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

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

getParserForType()

public Parser<Document.Page> getParserForType()
Returns
Type Description
Parser<Page>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTables(int index)

public Document.Page.Table getTables(int index)

A list of visually detected tables on the page.

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

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

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.Document.Page.VisualElement visual_elements = 9;

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

hasDimension()

public boolean hasDimension()

Physical dimension of the page.

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

Returns
Type Description
boolean

Whether the dimension field is set.

hasLayout()

public boolean hasLayout()

Layout for the page.

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

Returns
Type Description
boolean

Whether the layout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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>

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 Exceptions
Type Description
IOException