Package com.google.cloud.documentai.v1beta2

Interface Document.PageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Document.Page, Document.Page.Builder
    Enclosing class:
    Document
    public static interface Document.PageOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getPageNumber

        int getPageNumber()
         1-based index for current
 [Page][google.cloud.documentai.v1beta2.Document.Page] in a parent
 [Document][google.cloud.documentai.v1beta2.Document]. Useful when a page
 is taken out of a [Document][google.cloud.documentai.v1beta2.Document]
 for individual processing.
        int32 page_number = 1;
        Returns:
        The pageNumber.

      • hasImage

        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.v1beta2.Document.Page.Image image = 13;
        Returns:
        Whether the image field is set.

      • getImage

        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.v1beta2.Document.Page.Image image = 13;
        Returns:
        The image.

      • getImageOrBuilder

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

      • getTransformsList

        List<Document.Page.Matrix> getTransformsList()
         Transformation matrices that were applied to the original document image
 to produce
 [Page.image][google.cloud.documentai.v1beta2.Document.Page.image].
        repeated .google.cloud.documentai.v1beta2.Document.Page.Matrix transforms = 14;

      • getTransforms

        Document.Page.Matrix getTransforms​(int index)
         Transformation matrices that were applied to the original document image
 to produce
 [Page.image][google.cloud.documentai.v1beta2.Document.Page.image].
        repeated .google.cloud.documentai.v1beta2.Document.Page.Matrix transforms = 14;

      • getTransformsCount

        int getTransformsCount()
         Transformation matrices that were applied to the original document image
 to produce
 [Page.image][google.cloud.documentai.v1beta2.Document.Page.image].
        repeated .google.cloud.documentai.v1beta2.Document.Page.Matrix transforms = 14;

      • getTransformsOrBuilderList

        List<? extends Document.Page.MatrixOrBuilder> getTransformsOrBuilderList()
         Transformation matrices that were applied to the original document image
 to produce
 [Page.image][google.cloud.documentai.v1beta2.Document.Page.image].
        repeated .google.cloud.documentai.v1beta2.Document.Page.Matrix transforms = 14;

      • getTransformsOrBuilder

        Document.Page.MatrixOrBuilder getTransformsOrBuilder​(int index)
         Transformation matrices that were applied to the original document image
 to produce
 [Page.image][google.cloud.documentai.v1beta2.Document.Page.image].
        repeated .google.cloud.documentai.v1beta2.Document.Page.Matrix transforms = 14;

      • hasDimension

        boolean hasDimension()
         Physical dimension of the page.
        .google.cloud.documentai.v1beta2.Document.Page.Dimension dimension = 2;
        Returns:
        Whether the dimension field is set.

      • getDimension

        Document.Page.Dimension getDimension()
         Physical dimension of the page.
        .google.cloud.documentai.v1beta2.Document.Page.Dimension dimension = 2;
        Returns:
        The dimension.

      • getDimensionOrBuilder

        Document.Page.DimensionOrBuilder getDimensionOrBuilder()
         Physical dimension of the page.
        .google.cloud.documentai.v1beta2.Document.Page.Dimension dimension = 2;

      • hasLayout

        boolean hasLayout()
         [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
 page.
        .google.cloud.documentai.v1beta2.Document.Page.Layout layout = 3;
        Returns:
        Whether the layout field is set.

      • getLayout

        Document.Page.Layout getLayout()
         [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
 page.
        .google.cloud.documentai.v1beta2.Document.Page.Layout layout = 3;
        Returns:
        The layout.

      • getLayoutOrBuilder

        Document.Page.LayoutOrBuilder getLayoutOrBuilder()
         [Layout][google.cloud.documentai.v1beta2.Document.Page.Layout] for the
 page.
        .google.cloud.documentai.v1beta2.Document.Page.Layout layout = 3;

      • getDetectedLanguagesList

        List<Document.Page.DetectedLanguage> getDetectedLanguagesList()
         A list of detected languages together with confidence.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage detected_languages = 4;

      • getDetectedLanguages

        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;

      • getDetectedLanguagesCount

        int getDetectedLanguagesCount()
         A list of detected languages together with confidence.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage detected_languages = 4;

      • getDetectedLanguagesOrBuilderList

        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;

      • getDetectedLanguagesOrBuilder

        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;

      • getBlocksList

        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;

      • getBlocks

        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;

      • getBlocksCount

        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;

      • getBlocksOrBuilderList

        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;

      • getBlocksOrBuilder

        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;

      • getParagraphsList

        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;

      • getParagraphs

        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;

      • getParagraphsCount

        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;

      • getParagraphsOrBuilderList

        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;

      • getParagraphsOrBuilder

        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;

      • getLinesList

        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;

      • getLines

        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;

      • getLinesCount

        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;

      • getLinesOrBuilderList

        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;

      • getLinesOrBuilder

        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;

      • getTokensList

        List<Document.Page.Token> getTokensList()
         A list of visually detected tokens on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Token tokens = 8;

      • getTokens

        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;

      • getTokensCount

        int getTokensCount()
         A list of visually detected tokens on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Token tokens = 8;

      • getTokensOrBuilderList

        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;

      • getTokensOrBuilder

        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;

      • getVisualElementsList

        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;

      • getVisualElements

        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;

      • getVisualElementsCount

        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;

      • getVisualElementsOrBuilderList

        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;

      • getVisualElementsOrBuilder

        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;

      • getTablesList

        List<Document.Page.Table> getTablesList()
         A list of visually detected tables on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Table tables = 10;

      • getTables

        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;

      • getTablesCount

        int getTablesCount()
         A list of visually detected tables on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Table tables = 10;

      • getTablesOrBuilderList

        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;

      • getTablesOrBuilder

        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;

      • getFormFieldsList

        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;

      • getFormFields

        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;

      • getFormFieldsCount

        int getFormFieldsCount()
         A list of visually detected form fields on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.FormField form_fields = 11;

      • getFormFieldsOrBuilderList

        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;

      • getFormFieldsOrBuilder

        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;

      • getSymbolsList

        List<Document.Page.Symbol> getSymbolsList()
         A list of visually detected symbols on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Symbol symbols = 12;

      • getSymbols

        Document.Page.Symbol getSymbols​(int index)
         A list of visually detected symbols on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Symbol symbols = 12;

      • getSymbolsCount

        int getSymbolsCount()
         A list of visually detected symbols on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Symbol symbols = 12;

      • getSymbolsOrBuilderList

        List<? extends Document.Page.SymbolOrBuilder> getSymbolsOrBuilderList()
         A list of visually detected symbols on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Symbol symbols = 12;

      • getSymbolsOrBuilder

        Document.Page.SymbolOrBuilder getSymbolsOrBuilder​(int index)
         A list of visually detected symbols on the page.
        repeated .google.cloud.documentai.v1beta2.Document.Page.Symbol symbols = 12;

      • getDetectedBarcodesList

        List<Document.Page.DetectedBarcode> getDetectedBarcodesList()
         A list of detected barcodes.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode detected_barcodes = 15;

      • getDetectedBarcodes

        Document.Page.DetectedBarcode getDetectedBarcodes​(int index)
         A list of detected barcodes.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode detected_barcodes = 15;

      • getDetectedBarcodesCount

        int getDetectedBarcodesCount()
         A list of detected barcodes.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode detected_barcodes = 15;

      • getDetectedBarcodesOrBuilderList

        List<? extends Document.Page.DetectedBarcodeOrBuilder> getDetectedBarcodesOrBuilderList()
         A list of detected barcodes.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode detected_barcodes = 15;

      • getDetectedBarcodesOrBuilder

        Document.Page.DetectedBarcodeOrBuilder getDetectedBarcodesOrBuilder​(int index)
         A list of detected barcodes.
        repeated .google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode detected_barcodes = 15;

      • hasImageQualityScores

        boolean hasImageQualityScores()
         Image quality scores.
        .google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores image_quality_scores = 17;
        Returns:
        Whether the imageQualityScores field is set.

      • getImageQualityScores

        Document.Page.ImageQualityScores getImageQualityScores()
         Image quality scores.
        .google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores image_quality_scores = 17;
        Returns:
        The imageQualityScores.

      • getImageQualityScoresOrBuilder

        Document.Page.ImageQualityScoresOrBuilder getImageQualityScoresOrBuilder()
         Image quality scores.
        .google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores image_quality_scores = 17;

      • hasProvenance

        @Deprecated
boolean hasProvenance()
        Deprecated.
        google.cloud.documentai.v1beta2.Document.Page.provenance is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=577
         The history of this page.
        .google.cloud.documentai.v1beta2.Document.Provenance provenance = 16 [deprecated = true];
        Returns:
        Whether the provenance field is set.

      • getProvenance

        @Deprecated
Document.Provenance getProvenance()
        Deprecated.
        google.cloud.documentai.v1beta2.Document.Page.provenance is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=577
         The history of this page.
        .google.cloud.documentai.v1beta2.Document.Provenance provenance = 16 [deprecated = true];
        Returns:
        The provenance.

      • getProvenanceOrBuilder

        @Deprecated
Document.ProvenanceOrBuilder getProvenanceOrBuilder()
        Deprecated.
         The history of this page.
        .google.cloud.documentai.v1beta2.Document.Provenance provenance = 16 [deprecated = true];