Interface Document.PageOrBuilder (2.7.5)

Version 2.7.5

• 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 interface Document.PageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBlocks(int index)

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

getDetectedLanguages(int index)

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

getTables(int index)

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

getVisualElements(int index)

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