Package com.google.cloud.documentai.v1

Interface Document.PageAnchor.PageRefOrBuilder

    • Method Detail

      • getPage

        long getPage()
         Required. Index into the
 [Document.pages][google.cloud.documentai.v1.Document.pages] element,
 for example using
 `[Document.pages][page_refs.page]` to locate the related page element.
 This field is skipped when its value is the default `0`. See
 https://developers.google.com/protocol-buffers/docs/proto3#json.
        int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The page.

      • getLayoutTypeValue

        int getLayoutTypeValue()
         Optional. The type of the layout element that is being referenced if
 any.
        .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for layoutType.

      • getLayoutType

        Document.PageAnchor.PageRef.LayoutType getLayoutType()
         Optional. The type of the layout element that is being referenced if
 any.
        .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The layoutType.

      • getLayoutId

        @Deprecated
String getLayoutId()
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Returns:
        The layoutId.

      • getLayoutIdBytes

        @Deprecated
com.google.protobuf.ByteString getLayoutIdBytes()
        Deprecated.
        google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752
         Optional. Deprecated.  Use
 [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly]
 instead.
        string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for layoutId.

      • hasBoundingPoly

        boolean hasBoundingPoly()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the boundingPoly field is set.

      • getBoundingPoly

        BoundingPoly getBoundingPoly()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The boundingPoly.

      • getBoundingPolyOrBuilder

        BoundingPolyOrBuilder getBoundingPolyOrBuilder()
         Optional. Identifies the bounding polygon of a layout element on the
 page.
        .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getConfidence

        float getConfidence()
         Optional. Confidence of detected page element, if applicable. Range
 `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The confidence.