Class: Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document.rb

Overview

Represents a weak reference to a page element within a document.

Defined Under Namespace

Modules: LayoutType

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_poly ⇒ ::Google::Cloud::DocumentAI::V1beta3::BoundingPoly

Returns Optional. Identifies the bounding polygon of a layout element on the page.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 669

class PageRef
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of layout that is being referenced.
  module LayoutType
    # Layout Unspecified.
    LAYOUT_TYPE_UNSPECIFIED = 0

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element.
    BLOCK = 1

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element.
    PARAGRAPH = 2

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element.
    TOKEN = 4

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element.
    VISUAL_ELEMENT = 5

    # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element.
    TABLE = 6

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element.
    FORM_FIELD = 7
  end
end

#layout_id ⇒ ::String

Returns Optional. Deprecated. Use PageRef.bounding_poly instead.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 669

class PageRef
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of layout that is being referenced.
  module LayoutType
    # Layout Unspecified.
    LAYOUT_TYPE_UNSPECIFIED = 0

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element.
    BLOCK = 1

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element.
    PARAGRAPH = 2

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element.
    TOKEN = 4

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element.
    VISUAL_ELEMENT = 5

    # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element.
    TABLE = 6

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element.
    FORM_FIELD = 7
  end
end

#layout_type ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType

Returns Optional. The type of the layout element that is being referenced if any.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 669

class PageRef
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of layout that is being referenced.
  module LayoutType
    # Layout Unspecified.
    LAYOUT_TYPE_UNSPECIFIED = 0

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element.
    BLOCK = 1

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element.
    PARAGRAPH = 2

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element.
    TOKEN = 4

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element.
    VISUAL_ELEMENT = 5

    # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element.
    TABLE = 6

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element.
    FORM_FIELD = 7
  end
end

#page ⇒ ::Integer

Returns Required. Index into the Document.pages element, for example using [Document.pages][page_refs.page] to locate the related page element.

Returns:

  • (::Integer) —

    Required. Index into the Document.pages element, for example using [Document.pages][page_refs.page] to locate the related page element.



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 669

class PageRef
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of layout that is being referenced.
  module LayoutType
    # Layout Unspecified.
    LAYOUT_TYPE_UNSPECIFIED = 0

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element.
    BLOCK = 1

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element.
    PARAGRAPH = 2

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element.
    TOKEN = 4

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element.
    VISUAL_ELEMENT = 5

    # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element.
    TABLE = 6

    # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element.
    FORM_FIELD = 7
  end
end