Package com.google.cloud.documentai.v1

Class Document.Page.Layout

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Document.Page.Layout
All Implemented Interfaces:
Document.Page.LayoutOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Document.Page
public static final class Document.Page.Layout extends com.google.protobuf.GeneratedMessage implements Document.Page.LayoutOrBuilder
 Visual element describing a layout unit on a page.
Protobuf type google.cloud.documentai.v1.Document.Page.Layout
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Document.Page.Layout.Builder
    Visual element describing a layout unit on a page.
    static enum 
    Document.Page.Layout.Orientation
    Detected human reading orientation.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOUNDING_POLY_FIELD_NUMBER
     
    static final int
    CONFIDENCE_FIELD_NUMBER
     
    static final int
    ORIENTATION_FIELD_NUMBER
     
    static final int
    TEXT_ANCHOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    BoundingPoly
    getBoundingPoly()
    The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
    BoundingPolyOrBuilder
    getBoundingPolyOrBuilder()
    The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
    float
    getConfidence()
    Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this layout is for.
    static Document.Page.Layout
    getDefaultInstance()
     
    Document.Page.Layout
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Document.Page.Layout.Orientation
    getOrientation()
    Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
    int
    getOrientationValue()
    Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
    com.google.protobuf.Parser<Document.Page.Layout>
    getParserForType()
     
    int
    getSerializedSize()
     
    Document.TextAnchor
    getTextAnchor()
    Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
    Document.TextAnchorOrBuilder
    getTextAnchorOrBuilder()
    Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
    boolean
    hasBoundingPoly()
    The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
    int
    hashCode()
     
    boolean
    hasTextAnchor()
    Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Document.Page.Layout.Builder
    newBuilder()
     
    static Document.Page.Layout.Builder
    newBuilder(Document.Page.Layout prototype)
     
    Document.Page.Layout.Builder
    newBuilderForType()
     
    protected Document.Page.Layout.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Document.Page.Layout
    parseDelimitedFrom(InputStream input)
     
    static Document.Page.Layout
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document.Page.Layout
    parseFrom(byte[] data)
     
    static Document.Page.Layout
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document.Page.Layout
    parseFrom(com.google.protobuf.ByteString data)
     
    static Document.Page.Layout
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document.Page.Layout
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Document.Page.Layout
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document.Page.Layout
    parseFrom(InputStream input)
     
    static Document.Page.Layout
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document.Page.Layout
    parseFrom(ByteBuffer data)
     
    static Document.Page.Layout
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Document.Page.Layout>
    parser()
     
    Document.Page.Layout.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • TEXT_ANCHOR_FIELD_NUMBER

      public static final int TEXT_ANCHOR_FIELD_NUMBER
      See Also:

    • CONFIDENCE_FIELD_NUMBER

      public static final int CONFIDENCE_FIELD_NUMBER
      See Also:

    • BOUNDING_POLY_FIELD_NUMBER

      public static final int BOUNDING_POLY_FIELD_NUMBER
      See Also:

    • ORIENTATION_FIELD_NUMBER

      public static final int ORIENTATION_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

    • hasTextAnchor

      public boolean hasTextAnchor()
       Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;
      Specified by:
      hasTextAnchor in interface Document.Page.LayoutOrBuilder
      Returns:
      Whether the textAnchor field is set.

    • getTextAnchor

      public Document.TextAnchor getTextAnchor()
       Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;
      Specified by:
      getTextAnchor in interface Document.Page.LayoutOrBuilder
      Returns:
      The textAnchor.

    • getTextAnchorOrBuilder

      public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()
       Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;
      Specified by:
      getTextAnchorOrBuilder in interface Document.Page.LayoutOrBuilder

    • getConfidence

      public float getConfidence()
       Confidence of the current
 [Layout][google.cloud.documentai.v1.Document.Page.Layout] within
 context of the object this layout is for. For example, confidence can
 be for a single token, a table, a visual element, etc. depending on
 context. Range `[0, 1]`.
      float confidence = 2;
      Specified by:
      getConfidence in interface Document.Page.LayoutOrBuilder
      Returns:
      The confidence.

    • hasBoundingPoly

      public boolean hasBoundingPoly()
       The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;
      Specified by:
      hasBoundingPoly in interface Document.Page.LayoutOrBuilder
      Returns:
      Whether the boundingPoly field is set.

    • getBoundingPoly

      public BoundingPoly getBoundingPoly()
       The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;
      Specified by:
      getBoundingPoly in interface Document.Page.LayoutOrBuilder
      Returns:
      The boundingPoly.

    • getBoundingPolyOrBuilder

      public BoundingPolyOrBuilder getBoundingPolyOrBuilder()
       The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
      .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;
      Specified by:
      getBoundingPolyOrBuilder in interface Document.Page.LayoutOrBuilder

    • getOrientationValue

      public int getOrientationValue()
       Detected orientation for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
      .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;
      Specified by:
      getOrientationValue in interface Document.Page.LayoutOrBuilder
      Returns:
      The enum numeric value on the wire for orientation.

    • getOrientation

      public Document.Page.Layout.Orientation getOrientation()
       Detected orientation for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
      .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;
      Specified by:
      getOrientation in interface Document.Page.LayoutOrBuilder
      Returns:
      The orientation.

    • 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.Page.Layout parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Document.Page.Layout 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.Page.Layout parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Document.Page.Layout parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Document.Page.Layout parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Document.Page.Layout.Builder newBuilder()

    • newBuilder

      public static Document.Page.Layout.Builder newBuilder(Document.Page.Layout prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Document.Page.Layout getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document.Page.Layout> parser()

    • getParserForType

      public com.google.protobuf.Parser<Document.Page.Layout> 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.Page.Layout getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder