Package com.google.cloud.documentai.v1

Class Document.PageAnchor.PageRef

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Document.PageAnchor.PageRef
All Implemented Interfaces:
Document.PageAnchor.PageRefOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Document.PageAnchor
public static final class Document.PageAnchor.PageRef extends com.google.protobuf.GeneratedMessage implements Document.PageAnchor.PageRefOrBuilder
 Represents a weak reference to a page element within a document.
Protobuf type google.cloud.documentai.v1.Document.PageAnchor.PageRef
See Also:

  • Field Details

    • PAGE_FIELD_NUMBER

      public static final int PAGE_FIELD_NUMBER
      See Also:

    • LAYOUT_TYPE_FIELD_NUMBER

      public static final int LAYOUT_TYPE_FIELD_NUMBER
      See Also:

    • LAYOUT_ID_FIELD_NUMBER

      public static final int LAYOUT_ID_FIELD_NUMBER
      See Also:

    • BOUNDING_POLY_FIELD_NUMBER

      public static final int BOUNDING_POLY_FIELD_NUMBER
      See Also:

    • CONFIDENCE_FIELD_NUMBER

      public static final int CONFIDENCE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPage

      public 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];
      Specified by:
      getPage in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The page.

    • getLayoutTypeValue

      public 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];
      Specified by:
      getLayoutTypeValue in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The enum numeric value on the wire for layoutType.

    • getLayoutType

      public 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];
      Specified by:
      getLayoutType in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The layoutType.

    • getLayoutId

      @Deprecated public String getLayoutId()
      Deprecated.
      google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=775
       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];
      Specified by:
      getLayoutId in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The layoutId.

    • getLayoutIdBytes

      @Deprecated public 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=775
       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];
      Specified by:
      getLayoutIdBytes in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The bytes for layoutId.

    • hasBoundingPoly

      public boolean hasBoundingPoly()
       Optional. Identifies the bounding polygon of a layout element on the
 page. If `layout_type` is set, the bounding polygon must be exactly the
 same to the layout element it's referring to.
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      Whether the boundingPoly field is set.

    • getBoundingPoly

      public BoundingPoly getBoundingPoly()
       Optional. Identifies the bounding polygon of a layout element on the
 page. If `layout_type` is set, the bounding polygon must be exactly the
 same to the layout element it's referring to.
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The boundingPoly.

    • getBoundingPolyOrBuilder

      public BoundingPolyOrBuilder getBoundingPolyOrBuilder()
       Optional. Identifies the bounding polygon of a layout element on the
 page. If `layout_type` is set, the bounding polygon must be exactly the
 same to the layout element it's referring to.
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoundingPolyOrBuilder in interface Document.PageAnchor.PageRefOrBuilder

    • getConfidence

      public float getConfidence()
       Optional. Confidence of detected page element, if applicable. Range
 `[0, 1]`.
      float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConfidence in interface Document.PageAnchor.PageRefOrBuilder
      Returns:
      The confidence.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Document.PageAnchor.PageRef.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Document.PageAnchor.PageRef.Builder newBuilder()

    • newBuilder

      public static Document.PageAnchor.PageRef.Builder newBuilder(Document.PageAnchor.PageRef prototype)

    • toBuilder

      public Document.PageAnchor.PageRef.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Document.PageAnchor.PageRef.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document.PageAnchor.PageRef getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document.PageAnchor.PageRef> parser()

    • getParserForType

      public com.google.protobuf.Parser<Document.PageAnchor.PageRef> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Document.PageAnchor.PageRef getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder