Package com.google.cloud.vision.v1

Class TextAnnotation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.vision.v1.TextAnnotation
All Implemented Interfaces:
TextAnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TextAnnotation extends com.google.protobuf.GeneratedMessage implements TextAnnotationOrBuilder
 TextAnnotation contains a structured representation of OCR extracted text.
 The hierarchy of an OCR extracted text structure is like this:
 TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
 Each structural component, starting from Page, may further have their own
 properties. Properties describe detected languages, breaks etc.. Please refer
 to the
 [TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty]
 message definition below for more detail.
Protobuf type google.cloud.vision.v1.TextAnnotation
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TextAnnotation.Builder
    TextAnnotation contains a structured representation of OCR extracted text.
    static final class 
    TextAnnotation.DetectedBreak
    Detected start or end of a structural component.
    static interface 
    TextAnnotation.DetectedBreakOrBuilder
     
    static final class 
    TextAnnotation.DetectedLanguage
    Detected language for a structural component.
    static interface 
    TextAnnotation.DetectedLanguageOrBuilder
     
    static final class 
    TextAnnotation.TextProperty
    Additional information detected on the structural component.
    static interface 
    TextAnnotation.TextPropertyOrBuilder
     

    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
    PAGES_FIELD_NUMBER
     
    static final int
    TEXT_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)
     
    static TextAnnotation
    getDefaultInstance()
     
    TextAnnotation
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Page
    getPages(int index)
    List of pages detected by OCR.
    int
    getPagesCount()
    List of pages detected by OCR.
    List<Page>
    getPagesList()
    List of pages detected by OCR.
    PageOrBuilder
    getPagesOrBuilder(int index)
    List of pages detected by OCR.
    List<? extends PageOrBuilder>
    getPagesOrBuilderList()
    List of pages detected by OCR.
    com.google.protobuf.Parser<TextAnnotation>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getText()
    UTF-8 text detected on the pages.
    com.google.protobuf.ByteString
    getTextBytes()
    UTF-8 text detected on the pages.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TextAnnotation.Builder
    newBuilder()
     
    static TextAnnotation.Builder
    newBuilder(TextAnnotation prototype)
     
    TextAnnotation.Builder
    newBuilderForType()
     
    protected TextAnnotation.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TextAnnotation
    parseDelimitedFrom(InputStream input)
     
    static TextAnnotation
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextAnnotation
    parseFrom(byte[] data)
     
    static TextAnnotation
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextAnnotation
    parseFrom(com.google.protobuf.ByteString data)
     
    static TextAnnotation
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextAnnotation
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TextAnnotation
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextAnnotation
    parseFrom(InputStream input)
     
    static TextAnnotation
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextAnnotation
    parseFrom(ByteBuffer data)
     
    static TextAnnotation
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TextAnnotation>
    parser()
     
    TextAnnotation.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

  • 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

    • getPagesList

      public List<Page> getPagesList()
       List of pages detected by OCR.
      repeated .google.cloud.vision.v1.Page pages = 1;
      Specified by:
      getPagesList in interface TextAnnotationOrBuilder

    • getPagesOrBuilderList

      public List<? extends PageOrBuilder> getPagesOrBuilderList()
       List of pages detected by OCR.
      repeated .google.cloud.vision.v1.Page pages = 1;
      Specified by:
      getPagesOrBuilderList in interface TextAnnotationOrBuilder

    • getPagesCount

      public int getPagesCount()
       List of pages detected by OCR.
      repeated .google.cloud.vision.v1.Page pages = 1;
      Specified by:
      getPagesCount in interface TextAnnotationOrBuilder

    • getPages

      public Page getPages(int index)
       List of pages detected by OCR.
      repeated .google.cloud.vision.v1.Page pages = 1;
      Specified by:
      getPages in interface TextAnnotationOrBuilder

    • getPagesOrBuilder

      public PageOrBuilder getPagesOrBuilder(int index)
       List of pages detected by OCR.
      repeated .google.cloud.vision.v1.Page pages = 1;
      Specified by:
      getPagesOrBuilder in interface TextAnnotationOrBuilder

    • getText

      public String getText()
       UTF-8 text detected on the pages.
      string text = 2;
      Specified by:
      getText in interface TextAnnotationOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       UTF-8 text detected on the pages.
      string text = 2;
      Specified by:
      getTextBytes in interface TextAnnotationOrBuilder
      Returns:
      The bytes for text.

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

    • parseFrom

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

    • parseFrom

      public static TextAnnotation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TextAnnotation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static TextAnnotation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static TextAnnotation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TextAnnotation.Builder newBuilder()

    • newBuilder

      public static TextAnnotation.Builder newBuilder(TextAnnotation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TextAnnotation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TextAnnotation> parser()

    • getParserForType

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