Class Document.Layout

  • All Implemented Interfaces:
    Document.LayoutOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Document

    public static final class Document.Layout
    extends com.google.protobuf.GeneratedMessageV3
    implements Document.LayoutOrBuilder
     Describes the layout information of a [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the document.
     
    Protobuf type google.cloud.automl.v1.Document.Layout
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Document.Layout.Builder
      Describes the layout information of a [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the document.
      static class  Document.Layout.TextSegmentType
      The type of TextSegment in the context of the original document.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Detail

      • TEXT_SEGMENT_FIELD_NUMBER

        public static final int TEXT_SEGMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PAGE_NUMBER_FIELD_NUMBER

        public static final int PAGE_NUMBER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BOUNDING_POLY_FIELD_NUMBER

        public static final int BOUNDING_POLY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TEXT_SEGMENT_TYPE_FIELD_NUMBER

        public static final int TEXT_SEGMENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasTextSegment

        public boolean hasTextSegment()
         Text Segment that represents a segment in
         [document_text][google.cloud.automl.v1p1beta.Document.document_text].
         
        .google.cloud.automl.v1.TextSegment text_segment = 1;
        Specified by:
        hasTextSegment in interface Document.LayoutOrBuilder
        Returns:
        Whether the textSegment field is set.
      • getTextSegment

        public TextSegment getTextSegment()
         Text Segment that represents a segment in
         [document_text][google.cloud.automl.v1p1beta.Document.document_text].
         
        .google.cloud.automl.v1.TextSegment text_segment = 1;
        Specified by:
        getTextSegment in interface Document.LayoutOrBuilder
        Returns:
        The textSegment.
      • getPageNumber

        public int getPageNumber()
         Page number of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the original document, starts
         from 1.
         
        int32 page_number = 2;
        Specified by:
        getPageNumber in interface Document.LayoutOrBuilder
        Returns:
        The pageNumber.
      • hasBoundingPoly

        public boolean hasBoundingPoly()
         The position of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the page.
         Contains exactly 4
         [normalized_vertices][google.cloud.automl.v1p1beta.BoundingPoly.normalized_vertices]
         and they are connected by edges in the order provided, which will
         represent a rectangle parallel to the frame. The
         [NormalizedVertex-s][google.cloud.automl.v1p1beta.NormalizedVertex] are
         relative to the page.
         Coordinates are based on top-left as point (0,0).
         
        .google.cloud.automl.v1.BoundingPoly bounding_poly = 3;
        Specified by:
        hasBoundingPoly in interface Document.LayoutOrBuilder
        Returns:
        Whether the boundingPoly field is set.
      • getBoundingPoly

        public BoundingPoly getBoundingPoly()
         The position of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the page.
         Contains exactly 4
         [normalized_vertices][google.cloud.automl.v1p1beta.BoundingPoly.normalized_vertices]
         and they are connected by edges in the order provided, which will
         represent a rectangle parallel to the frame. The
         [NormalizedVertex-s][google.cloud.automl.v1p1beta.NormalizedVertex] are
         relative to the page.
         Coordinates are based on top-left as point (0,0).
         
        .google.cloud.automl.v1.BoundingPoly bounding_poly = 3;
        Specified by:
        getBoundingPoly in interface Document.LayoutOrBuilder
        Returns:
        The boundingPoly.
      • getBoundingPolyOrBuilder

        public BoundingPolyOrBuilder getBoundingPolyOrBuilder()
         The position of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the page.
         Contains exactly 4
         [normalized_vertices][google.cloud.automl.v1p1beta.BoundingPoly.normalized_vertices]
         and they are connected by edges in the order provided, which will
         represent a rectangle parallel to the frame. The
         [NormalizedVertex-s][google.cloud.automl.v1p1beta.NormalizedVertex] are
         relative to the page.
         Coordinates are based on top-left as point (0,0).
         
        .google.cloud.automl.v1.BoundingPoly bounding_poly = 3;
        Specified by:
        getBoundingPolyOrBuilder in interface Document.LayoutOrBuilder
      • getTextSegmentTypeValue

        public int getTextSegmentTypeValue()
         The type of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in document.
         
        .google.cloud.automl.v1.Document.Layout.TextSegmentType text_segment_type = 4;
        Specified by:
        getTextSegmentTypeValue in interface Document.LayoutOrBuilder
        Returns:
        The enum numeric value on the wire for textSegmentType.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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.Layout parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

        protected Document.Layout.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • parser

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

        public com.google.protobuf.Parser<Document.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.GeneratedMessageV3
      • getDefaultInstanceForType

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