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.v1beta1.Document.Page

Fields

BLOCKS_FIELD_NUMBER

public static final int BLOCKS_FIELD_NUMBER
Field Value
TypeDescription
int

DETECTED_LANGUAGES_FIELD_NUMBER

public static final int DETECTED_LANGUAGES_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER
Field Value
TypeDescription
int

FORM_FIELDS_FIELD_NUMBER

public static final int FORM_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

LINES_FIELD_NUMBER

public static final int LINES_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_NUMBER_FIELD_NUMBER

public static final int PAGE_NUMBER_FIELD_NUMBER
Field Value
TypeDescription
int

PARAGRAPHS_FIELD_NUMBER

public static final int PARAGRAPHS_FIELD_NUMBER
Field Value
TypeDescription
int

TABLES_FIELD_NUMBER

public static final int TABLES_FIELD_NUMBER
Field Value
TypeDescription
int

TOKENS_FIELD_NUMBER

public static final int TOKENS_FIELD_NUMBER
Field Value
TypeDescription
int

VISUAL_ELEMENTS_FIELD_NUMBER

public static final int VISUAL_ELEMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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.v1beta1.Document.Page.Block blocks = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Block blocks = 5;

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Block blocks = 5;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.BlockOrBuilder>

getDefaultInstance()

public static Document.Page getDefaultInstance()
Returns
TypeDescription
Document.Page

getDefaultInstanceForType()

public Document.Page getDefaultInstanceForType()
Returns
TypeDescription
Document.Page

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDetectedLanguages(int index)

public Document.Page.DetectedLanguage getDetectedLanguages(int index)

A list of detected languages together with confidence.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguage

getDetectedLanguagesCount()

public int getDetectedLanguagesCount()

A list of detected languages together with confidence.

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

Returns
TypeDescription
int

getDetectedLanguagesList()

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

A list of detected languages together with confidence.

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

Returns
TypeDescription
List<DetectedLanguage>

getDetectedLanguagesOrBuilder(int index)

public Document.Page.DetectedLanguageOrBuilder getDetectedLanguagesOrBuilder(int index)

A list of detected languages together with confidence.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.DetectedLanguageOrBuilder

getDetectedLanguagesOrBuilderList()

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

A list of detected languages together with confidence.

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

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguageOrBuilder>

getDimension()

public Document.Page.Dimension getDimension()

Physical dimension of the page.

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

Returns
TypeDescription
Document.Page.Dimension

The dimension.

getDimensionOrBuilder()

public Document.Page.DimensionOrBuilder getDimensionOrBuilder()

Physical dimension of the page.

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

Returns
TypeDescription
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.v1beta1.Document.Page.FormField form_fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.FormField

getFormFieldsCount()

public int getFormFieldsCount()

A list of visually detected form fields on the page.

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

Returns
TypeDescription
int

getFormFieldsList()

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

A list of visually detected form fields on the page.

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

Returns
TypeDescription
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.v1beta1.Document.Page.FormField form_fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.FormField form_fields = 11;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.FormFieldOrBuilder>

getLayout()

public Document.Page.Layout getLayout()

Layout for the page.

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

Returns
TypeDescription
Document.Page.Layout

The layout.

getLayoutOrBuilder()

public Document.Page.LayoutOrBuilder getLayoutOrBuilder()

Layout for the page.

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

Returns
TypeDescription
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.v1beta1.Document.Page.Line lines = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Line lines = 7;

Returns
TypeDescription
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.v1beta1.Document.Page.Line lines = 7;

Returns
TypeDescription
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.v1beta1.Document.Page.Line lines = 7;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Line lines = 7;

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Paragraph paragraphs = 6;

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.Paragraph paragraphs = 6;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.ParagraphOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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.v1beta1.Document.Page.Table tables = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.Table

getTablesCount()

public int getTablesCount()

A list of visually detected tables on the page.

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

Returns
TypeDescription
int

getTablesList()

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

A list of visually detected tables on the page.

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

Returns
TypeDescription
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.v1beta1.Document.Page.Table tables = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.TableOrBuilder

getTablesOrBuilderList()

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

A list of visually detected tables on the page.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.Token

getTokensCount()

public int getTokensCount()

A list of visually detected tokens on the page.

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

Returns
TypeDescription
int

getTokensList()

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

A list of visually detected tokens on the page.

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

Returns
TypeDescription
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.v1beta1.Document.Page.Token tokens = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Page.TokenOrBuilder

getTokensOrBuilderList()

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

A list of visually detected tokens on the page.

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

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.TokenOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
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.v1beta1.Document.Page.VisualElement visual_elements = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.VisualElement visual_elements = 9;

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta1.Document.Page.VisualElement visual_elements = 9;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta1.Document.Page.VisualElementOrBuilder>

hasDimension()

public boolean hasDimension()

Physical dimension of the page.

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

Returns
TypeDescription
boolean

Whether the dimension field is set.

hasLayout()

public boolean hasLayout()

Layout for the page.

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

Returns
TypeDescription
boolean

Whether the layout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Document.Page.Builder newBuilder()
Returns
TypeDescription
Document.Page.Builder

newBuilder(Document.Page prototype)

public static Document.Page.Builder newBuilder(Document.Page prototype)
Parameter
NameDescription
prototypeDocument.Page
Returns
TypeDescription
Document.Page.Builder

newBuilderForType()

public Document.Page.Builder newBuilderForType()
Returns
TypeDescription
Document.Page.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Page.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Document.Page parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Page parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Page parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Page parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Document.Page> parser()
Returns
TypeDescription
Parser<Page>

toBuilder()

public Document.Page.Builder toBuilder()
Returns
TypeDescription
Document.Page.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException