public static final class Document.Page extends GeneratedMessageV3 implements Document.PageOrBuilder
A page in a Document.
Protobuf type google.cloud.documentai.v1.Document.Page
Fields
BLOCKS_FIELD_NUMBER
public static final int BLOCKS_FIELD_NUMBER
Field Value
DETECTED_LANGUAGES_FIELD_NUMBER
public static final int DETECTED_LANGUAGES_FIELD_NUMBER
Field Value
DIMENSION_FIELD_NUMBER
public static final int DIMENSION_FIELD_NUMBER
Field Value
FORM_FIELDS_FIELD_NUMBER
public static final int FORM_FIELDS_FIELD_NUMBER
Field Value
IMAGE_FIELD_NUMBER
public static final int IMAGE_FIELD_NUMBER
Field Value
LAYOUT_FIELD_NUMBER
public static final int LAYOUT_FIELD_NUMBER
Field Value
LINES_FIELD_NUMBER
public static final int LINES_FIELD_NUMBER
Field Value
PAGE_NUMBER_FIELD_NUMBER
public static final int PAGE_NUMBER_FIELD_NUMBER
Field Value
PARAGRAPHS_FIELD_NUMBER
public static final int PARAGRAPHS_FIELD_NUMBER
Field Value
PROVENANCE_FIELD_NUMBER
public static final int PROVENANCE_FIELD_NUMBER
Field Value
TABLES_FIELD_NUMBER
public static final int TABLES_FIELD_NUMBER
Field Value
TOKENS_FIELD_NUMBER
public static final int TOKENS_FIELD_NUMBER
Field Value
TRANSFORMS_FIELD_NUMBER
public static final int TRANSFORMS_FIELD_NUMBER
Field Value
VISUAL_ELEMENTS_FIELD_NUMBER
public static final int VISUAL_ELEMENTS_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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.v1.Document.Page.Block blocks = 5;
getBlocksCount()
public int getBlocksCount()
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common
line-spacing and orientation.
repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
getBlocksList()
public List<Document.Page.Block> getBlocksList()
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common
line-spacing and orientation.
repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
getBlocksOrBuilder(int index)
public Document.Page.BlockOrBuilder getBlocksOrBuilder(int index)
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common
line-spacing and orientation.
repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
getBlocksOrBuilderList()
public List<? extends Document.Page.BlockOrBuilder> getBlocksOrBuilderList()
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common
line-spacing and orientation.
repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.BlockOrBuilder> | |
getDefaultInstance()
public static Document.Page getDefaultInstance()
Returns
getDefaultInstanceForType()
public Document.Page getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDetectedLanguages(int index)
public Document.Page.DetectedLanguage getDetectedLanguages(int index)
A list of detected languages together with confidence.
repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
getDetectedLanguagesCount()
public int getDetectedLanguagesCount()
A list of detected languages together with confidence.
repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
getDetectedLanguagesList()
public List<Document.Page.DetectedLanguage> getDetectedLanguagesList()
A list of detected languages together with confidence.
repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
getDetectedLanguagesOrBuilder(int index)
public Document.Page.DetectedLanguageOrBuilder getDetectedLanguagesOrBuilder(int index)
A list of detected languages together with confidence.
repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
getDetectedLanguagesOrBuilderList()
public List<? extends Document.Page.DetectedLanguageOrBuilder> getDetectedLanguagesOrBuilderList()
A list of detected languages together with confidence.
repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.DetectedLanguageOrBuilder> | |
getDimension()
public Document.Page.Dimension getDimension()
Physical dimension of the page.
.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;
getDimensionOrBuilder()
public Document.Page.DimensionOrBuilder getDimensionOrBuilder()
Physical dimension of the page.
.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;
getFormFields(int index)
public Document.Page.FormField getFormFields(int index)
A list of visually detected form fields on the page.
repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
getFormFieldsCount()
public int getFormFieldsCount()
A list of visually detected form fields on the page.
repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
getFormFieldsList()
public List<Document.Page.FormField> getFormFieldsList()
A list of visually detected form fields on the page.
repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
getFormFieldsOrBuilder(int index)
public Document.Page.FormFieldOrBuilder getFormFieldsOrBuilder(int index)
A list of visually detected form fields on the page.
repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
getFormFieldsOrBuilderList()
public List<? extends Document.Page.FormFieldOrBuilder> getFormFieldsOrBuilderList()
A list of visually detected form fields on the page.
repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.FormFieldOrBuilder> | |
getImage()
public Document.Page.Image getImage()
Rendered image for this page. This image is preprocessed to remove any
skew, rotation, and distortions such that the annotation bounding boxes
can be upright and axis-aligned.
.google.cloud.documentai.v1.Document.Page.Image image = 13;
getImageOrBuilder()
public Document.Page.ImageOrBuilder getImageOrBuilder()
Rendered image for this page. This image is preprocessed to remove any
skew, rotation, and distortions such that the annotation bounding boxes
can be upright and axis-aligned.
.google.cloud.documentai.v1.Document.Page.Image image = 13;
getLayout()
public Document.Page.Layout getLayout()
Layout for the page.
.google.cloud.documentai.v1.Document.Page.Layout layout = 3;
getLayoutOrBuilder()
public Document.Page.LayoutOrBuilder getLayoutOrBuilder()
Layout for the page.
.google.cloud.documentai.v1.Document.Page.Layout layout = 3;
getLines(int index)
public Document.Page.Line getLines(int index)
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
getLinesCount()
public int getLinesCount()
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
getLinesList()
public List<Document.Page.Line> getLinesList()
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
getLinesOrBuilder(int index)
public Document.Page.LineOrBuilder getLinesOrBuilder(int index)
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
getLinesOrBuilderList()
public List<? extends Document.Page.LineOrBuilder> getLinesOrBuilderList()
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.LineOrBuilder> | |
getPageNumber()
public int getPageNumber()
1-based index for current Page in a parent Document.
Useful when a page is taken out of a Document for individual
processing.
int32 page_number = 1;
| Type | Description |
| int | The pageNumber.
|
getParagraphs(int index)
public Document.Page.Paragraph getParagraphs(int index)
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
getParagraphsCount()
public int getParagraphsCount()
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
getParagraphsList()
public List<Document.Page.Paragraph> getParagraphsList()
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
getParagraphsOrBuilder(int index)
public Document.Page.ParagraphOrBuilder getParagraphsOrBuilder(int index)
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
getParagraphsOrBuilderList()
public List<? extends Document.Page.ParagraphOrBuilder> getParagraphsOrBuilderList()
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.ParagraphOrBuilder> | |
getParserForType()
public Parser<Document.Page> getParserForType()
Returns
Overrides
getProvenance()
public Document.Provenance getProvenance()
The history of this page.
.google.cloud.documentai.v1.Document.Provenance provenance = 16;
getProvenanceOrBuilder()
public Document.ProvenanceOrBuilder getProvenanceOrBuilder()
The history of this page.
.google.cloud.documentai.v1.Document.Provenance provenance = 16;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTables(int index)
public Document.Page.Table getTables(int index)
A list of visually detected tables on the page.
repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
getTablesCount()
public int getTablesCount()
A list of visually detected tables on the page.
repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
getTablesList()
public List<Document.Page.Table> getTablesList()
A list of visually detected tables on the page.
repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
getTablesOrBuilder(int index)
public Document.Page.TableOrBuilder getTablesOrBuilder(int index)
A list of visually detected tables on the page.
repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
getTablesOrBuilderList()
public List<? extends Document.Page.TableOrBuilder> getTablesOrBuilderList()
A list of visually detected tables on the page.
repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.TableOrBuilder> | |
getTokens(int index)
public Document.Page.Token getTokens(int index)
A list of visually detected tokens on the page.
repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
getTokensCount()
public int getTokensCount()
A list of visually detected tokens on the page.
repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
getTokensList()
public List<Document.Page.Token> getTokensList()
A list of visually detected tokens on the page.
repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
getTokensOrBuilder(int index)
public Document.Page.TokenOrBuilder getTokensOrBuilder(int index)
A list of visually detected tokens on the page.
repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
getTokensOrBuilderList()
public List<? extends Document.Page.TokenOrBuilder> getTokensOrBuilderList()
A list of visually detected tokens on the page.
repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.TokenOrBuilder> | |
getTransforms(int index)
public Document.Page.Matrix getTransforms(int index)
Transformation matrices that were applied to the original document image
to produce Page.image.
repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
getTransformsCount()
public int getTransformsCount()
Transformation matrices that were applied to the original document image
to produce Page.image.
repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
getTransformsList()
public List<Document.Page.Matrix> getTransformsList()
Transformation matrices that were applied to the original document image
to produce Page.image.
repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
getTransformsOrBuilder(int index)
public Document.Page.MatrixOrBuilder getTransformsOrBuilder(int index)
Transformation matrices that were applied to the original document image
to produce Page.image.
repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
getTransformsOrBuilderList()
public List<? extends Document.Page.MatrixOrBuilder> getTransformsOrBuilderList()
Transformation matrices that were applied to the original document image
to produce Page.image.
repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.MatrixOrBuilder> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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.v1.Document.Page.VisualElement visual_elements = 9;
getVisualElementsCount()
public int getVisualElementsCount()
A list of detected non-text visual elements e.g. checkbox,
signature etc. on the page.
repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
getVisualElementsList()
public List<Document.Page.VisualElement> getVisualElementsList()
A list of detected non-text visual elements e.g. checkbox,
signature etc. on the page.
repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
getVisualElementsOrBuilder(int index)
public Document.Page.VisualElementOrBuilder getVisualElementsOrBuilder(int index)
A list of detected non-text visual elements e.g. checkbox,
signature etc. on the page.
repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
getVisualElementsOrBuilderList()
public List<? extends Document.Page.VisualElementOrBuilder> getVisualElementsOrBuilderList()
A list of detected non-text visual elements e.g. checkbox,
signature etc. on the page.
repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.Page.VisualElementOrBuilder> | |
hasDimension()
public boolean hasDimension()
Physical dimension of the page.
.google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;
| Type | Description |
| boolean | Whether the dimension field is set.
|
hasImage()
public boolean hasImage()
Rendered image for this page. This image is preprocessed to remove any
skew, rotation, and distortions such that the annotation bounding boxes
can be upright and axis-aligned.
.google.cloud.documentai.v1.Document.Page.Image image = 13;
| Type | Description |
| boolean | Whether the image field is set.
|
hasLayout()
public boolean hasLayout()
Layout for the page.
.google.cloud.documentai.v1.Document.Page.Layout layout = 3;
| Type | Description |
| boolean | Whether the layout field is set.
|
hasProvenance()
public boolean hasProvenance()
The history of this page.
.google.cloud.documentai.v1.Document.Provenance provenance = 16;
| Type | Description |
| boolean | Whether the provenance field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Document.Page.Builder newBuilder()
Returns
newBuilder(Document.Page prototype)
public static Document.Page.Builder newBuilder(Document.Page prototype)
Parameter
Returns
newBuilderForType()
public Document.Page.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
parseDelimitedFrom(InputStream input)
public static Document.Page parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document.Page parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document.Page parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static Document.Page parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static Document.Page parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document.Page parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document.Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Document.Page> parser()
Returns
toBuilder()
public Document.Page.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
